Complete electronic and manual verification
Last updated: Jul 4th, 12:35am
The next steps to complete merchant onboarding are electronic and manual verification. Unlike data collection, you must monitor and respond to data verification requests for all the merchant accounts you create.
Monitor electronic verification webhooks
After creating a merchant account, you receive the CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED webhook, indicating that the verification process for your merchant has begun.
The webhook contains:
- Account identifiers
- A summary of the changes
- A link to the GET call
After you receive a webhook, use your token to make a GET call to /v3/customer/managed-accounts/ACCOUNT-ID and pass the merchant's account id in ACCOUNT-ID.
- Request
- Response
1curl --location --request GET ‘{{host}}/v3/customer/managed-accounts/ACCOUNT-ID’ --header ‘Authorization: Bearer ACCESS-TOKEN’ --header 'Content-Type: application/json'
A successful request returns an HTTP 200 OK status code and a JSON response body. This body includes details of the submitted application information, the account's verification status, and a list of additional information or documentation required to complete the verification process.
Confirm electronic verification completion
Interpret the GET API response for the endpoint /v3/customer/managed-accounts/{id} to locate the capabilities array.
The response for this GET API request includes the capabilities array as a top-level entity. This array details the account's capabilities, current statuses, and associated payment processing limits. The API response returns various types of capabilities.
|
Capabilities |
Definition |
|
SEND_MONEY |
Ability to send money as branded PayPal payments. |
|
RECEIVE_MONEY |
Ability to receive money as branded PayPal payments. |
|
WITHDRAW_MONEY |
Ability for a merchant to withdraw money directly to their bank account. This capability doesn't apply to partners using settlement consolidation. |
|
CUSTOM_CARD_PROCESSING |
Ability to receive card payments as an unbranded credit and debit card. |
|
CUSTOM_BANK_PROCESSING |
Ability to receive direct bank payments as unbranded bank payments. |
|
APPLE_PAY |
Ability to receive Apple Pay payments as unbranded wallet payments. |
|
GOOGLE_PAY |
Ability to receive Google Pay payments as unbranded wallet payments. |
Sample response for successful electronic verification
If the electronic verification is successful, each capability has "status": "ACTIVE". If all capabilities have "status": "ACTIVE" and no limits associated with them, the merchant passes the electronic verification and requires no further action.
1{23 "account_id": "23PC3HNADFP2J",45 "legal_country_code": "FR",67 "individual_owners": [89 {1011 "id": "23PC3HNADFP2J",1213 "names": [1415 {1617 "given_name": "Levin",1819 "surname": "Huang",2021 "id": "HAKBCPJRUZEP2",2223 "type": "LEGAL"2425 }2627 ],2829 "citizenship": "FR",3031 "primary_residence": {3233 "address_line_1": "24 rue du Faubourg Saint Honore",3435 "address_line_2": "Unit 2000",3637 "admin_area_2": "Paris",3839 "postal_code": "75008",4041 "country_code": "FR"4243 },4445 "phone_numbers": [4647 {4849 "country_code": "030",5051 "national_number": "6151175",5253 "id": "VB4FDVSH3KHGS",5455 "type": "MOBILE"5657 }5859 ],6061 "birth_details": {6263 "date_of_birth": "1995-08-01"6465 },6667 "identification_documents": [6869 {7071 "id": "9BMVHX9HM5H3G",7273 "identification_number": "****",7475 "issuing_country_code": "FR",7677 "type": "PASSPORT"7879 }8081 ],8283 "emails": [8485 {8687 "id": "C6Z86SFR4Q75J",8889 "email": "levin-personal-email@paypal.com"9091 }9293 ]9495 }9697 ],9899 "business_entity": {100101 "type": "CORPORATION",102103 "merchant_category_code": "5933",104105 "incorporation_details": {106107 "incorporation_country_code": "FR",108109 "incorporation_date": "1999-01-10"110111 },112113 "names": [114115 {116117 "business_name": "FINTECH UNICORN",118119 "id": "5JD67U874KZJY",120121 "type": "LEGAL"122123 }124125 ],126127 "emails": [128129 {130131 "id": "U4WENYWD5X7PU",132133 "email": "levin-business-email@paypal.com"134135 }136137 ],138139 "website": "https://developer.paypal.com/docs/multiparty/",140141 "registered_business_address": {142143 "address_line_1": "24 rue du Faubourg Saint Honore",144145 "address_line_2": "Unit 2100",146147 "admin_area_2": "Paris",148149 "postal_code": "75008",150151 "country_code": "FR"152153 },154155 "phone_numbers": [156157 {158159 "country_code": "1",160161 "national_number": "06151188",162163 "id": "HQE3JWM26N8UU",164165 "type": "BUSINESS"166167 }168169 ],170171 "identification_documents": [172173 {174175 "id": "42HL7HRQHT2JL",176177 "identification_number": "****",178179 "issuing_country_code": "FR",180181 "type": "BUSINESS_REGISTRATION_NUMBER"182183 }184185 ],186187 "declarations": [188189 {190191 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",192193 "value": "NO"194195 }196197 ]198199 },200201 "agreements": [202203 {204205 "type": "TERMS_ACCEPTED",206207 "accepted_time": "2024-01-01T00:00:00Z"208209 }210211 ],212213 "external_id": "EXT-1707167597",214215 "organization": "us_org/net",216217 "user_id": "1707167597387",218219 "primary_currency_code": "EUR",220221 "soft_descriptor": "FINTECHUNIC",222223 "capabilities": [224225 {226227 "name": "APPLE_PAY",228229 "status": "ACTIVE"230231 },232233 {234235 "name": "GOOGLE_PAY",236237 "status": "ACTIVE"238239 },240241 {242243 "name": "CUSTOM_CARD_PROCESSING",244245 "status": "ACTIVE"246247 },248249 {250251 "name": "RECEIVE_MONEY",252253 "status": "ACTIVE"254255 },256257 {258259 "name": "WITHDRAW_MONEY",260261 "status": "ACTIVE"262263 }264265 ],266267 "process_view": {268269 "processes": [270271 {272273 "name": "MANAGED_PATH_CIP_COLLECTION",274275 "status": "COMPLETED",276277 "capabilities": [278279 {280281 "name": "RECEIVE_MONEY"282283 },284285 {286287 "name": "WITHDRAW_MONEY"288289 },290291 {292293 "name": "GOOGLE_PAY"294295 },296297 {298299 "name": "APPLE_PAY"300301 },302303 {304305 "name": "CUSTOM_CARD_PROCESSING"306307 }308309 ]310311 },312313 {314315 "name": "MANAGED_PATH_KYC",316317 "status": "COMPLETED",318319 "capabilities": [320321 {322323 "name": "WITHDRAW_MONEY"324325 },326327 {328329 "name": "CUSTOM_CARD_PROCESSING"330331 },332333 {334335 "name": "GOOGLE_PAY"336337 },338339 {340341 "name": "APPLE_PAY"342343 }344345 ]346347 }348349 ]350351 },352353 "links": [354355 {356357 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/23PC3HNADFP2J",358359 "rel": "self",360361 "method": "GET"362363 },364365 {366367 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/23PC3HNADFP2J",368369 "rel": "edit",370371 "method": "PATCH"372373 }374375 ]376377}
Sample response when data is incomplete
If the status is not "ACTIVE" or if there are "limits" displayed under the capability, the merchant still needs to pass the electronic verification.
1{2 "account_id": "23PC3HNADFP2J",3 "legal_country_code": "FR",4 "individual_owners": [5 {6 "id": "23PC3HNADFP2J",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "HAKBCPJRUZEP2",12 "type": "LEGAL"13 }14 ],15 "citizenship": "FR",16 "primary_residence": {17 "address_line_1": "24 rue du Faubourg Saint Honore",18 "address_line_2": "Unit 2000",19 "admin_area_2": "Paris",20 "postal_code": "75008",21 "country_code": "FR"22 },23 "phone_numbers": [24 {25 "country_code": "030",26 "national_number": "6151175",27 "id": "VB4FDVSH3KHGS",28 "type": "MOBILE"29 }30 ],31 "birth_details": {32 "date_of_birth": "1995-08-01"33 },34 "identification_documents": [35 {36 "id": "9BMVHX9HM5H3G",37 "identification_number": "****",38 "issuing_country_code": "FR",39 "type": "PASSPORT"40 }41 ],42 "emails": [43 {44 "id": "C6Z86SFR4Q75J",45 "email": "levin-personal-email@paypal.com"46 }47 ]48 }49 ],50 "business_entity": {51 "type": "CORPORATION",52 "merchant_category_code": "5933",53 "incorporation_details": {54 "incorporation_country_code": "FR",55 "incorporation_date": "1999-01-10"56 },57 "names": [58 {59 "business_name": "FINTECH UNICORN",60 "id": "5JD67U874KZJY",61 "type": "LEGAL"62 }63 ],64 "emails": [65 {66 "id": "U4WENYWD5X7PU",67 "email": "levin-business-email@paypal.com"68 }69 ],70 "website": "https://developer.paypal.com/docs/multiparty/",71 "registered_business_address": {72 "address_line_1": "24 rue du Faubourg Saint Honore",73 "address_line_2": "Unit 2100",74 "admin_area_2": "Paris",75 "postal_code": "75008",76 "country_code": "FR"77 },78 "phone_numbers": [79 {80 "country_code": "1",81 "national_number": "06151188",82 "id": "HQE3JWM26N8UU",83 "type": "BUSINESS"84 }85 ],86 "identification_documents": [87 {88 "id": "42HL7HRQHT2JL",89 "identification_number": "****",90 "issuing_country_code": "FR",91 "type": "BUSINESS_REGISTRATION_NUMBER"92 }93 ],94 "declarations": [95 {96 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",97 "value": "NO"98 }99 ]100 },101 "agreements": [102 {103 "type": "TERMS_ACCEPTED",104 "accepted_time": "2024-01-01T00:00:00Z"105 }106 ],107 "external_id": "EXT-1707167597",108 "organization": "us_org/net",109 "user_id": "1707167597387",110 "primary_currency_code": "EUR",111 "soft_descriptor": "FINTECHUNIC",112 "capabilities": [113 {114 "name": "APPLE_PAY",115 "limits": [116 {117 "type": "AMOUNT",118 "unit": "EUR",119 "value": "1000.00",120 "remaining_value": "1000.00",121 "implication_of_limit_breach": "START_GRACE_PERIOD"122 }123 ],124 "status": "ACTIVE"125 },126 {127 "name": "GOOGLE_PAY",128 "limits": [129 {130 "type": "AMOUNT",131 "unit": "EUR",132 "value": "1000.00",133 "remaining_value": "1000.00",134 "implication_of_limit_breach": "START_GRACE_PERIOD"135 }136 ],137 "status": "ACTIVE"138 },139 {140 "name": "CUSTOM_CARD_PROCESSING",141 "limits": [142 {143 "type": "AMOUNT",144 "unit": "EUR",145 "value": "1000.00",146 "remaining_value": "1000.00",147 "implication_of_limit_breach": "START_GRACE_PERIOD"148 }149 ],150 "status": "ACTIVE"151 },152 {153 "name": "RECEIVE_MONEY",154 "status": "ACTIVE"155 },156 {157 "name": "WITHDRAW_MONEY",158 "limits": [159 {160 "type": "AMOUNT",161 "unit": "EUR",162 "value": "1000.00",163 "remaining_value": "1000.00",164 "implication_of_limit_breach": "BLOCK_CAPABILITY"165 }166 ],167 "status": "ACTIVE"168 }169 ],170 "process_view": {171 "processes": [172 {173 "name": "MANAGED_PATH_CIP_COLLECTION",174 "status": "COMPLETED",175 "capabilities": [176 {177 "name": "RECEIVE_MONEY"178 },179 {180 "name": "WITHDRAW_MONEY"181 },182 {183 "name": "GOOGLE_PAY"184 },185 {186 "name": "APPLE_PAY"187 },188 {189 "name": "CUSTOM_CARD_PROCESSING"190 }191 ]192 },193 {194 "name": "MANAGED_PATH_KYC",195 "status": "NEED_MORE_DATA",196 "capabilities": [197 {198 "name": "WITHDRAW_MONEY",199 "limits": [200 {201 "type": "AMOUNT",202 "unit": "EUR",203 "value": "1000.00",204 "remaining_value": "1000.00",205 "implication_of_limit_breach": "BLOCK_CAPABILITY"206 }207 ]208 },209 {210 "name": "CUSTOM_CARD_PROCESSING",211 "limits": [212 {213 "type": "AMOUNT",214 "unit": "EUR",215 "value": "1000.00",216 "remaining_value": "1000.00",217 "implication_of_limit_breach": "START_GRACE_PERIOD"218 }219 ]220 },221 {222 "name": "GOOGLE_PAY",223 "limits": [224 {225 "type": "AMOUNT",226 "unit": "EUR",227 "value": "1000.00",228 "remaining_value": "1000.00",229 "implication_of_limit_breach": "START_GRACE_PERIOD"230 }231 ]232 },233 {234 "name": "APPLE_PAY",235 "limits": [236 {237 "type": "AMOUNT",238 "unit": "EUR",239 "value": "1000.00",240 "remaining_value": "1000.00",241 "implication_of_limit_breach": "START_GRACE_PERIOD"242 }243 ]244 }245 ],246 "required": {247 "op": "ALL_OF",248 "attributes": [249 {250 "op": "ONE_OF",251 "attributes": [252 {253 "op": "ALL_OF",254 "attributes": [255 "$.business_entity.office_bearers[?(@['role']=='CEO')].citizenship",256 "$.business_entity.office_bearers[?(@['role']=='CEO')].names[?(@['type']=='LEGAL')]",257 "$.business_entity.office_bearers[?(@['role']=='CEO')].birth_details.date_of_birth",258 "$.business_entity.office_bearers[?(@['role']=='CEO')].addresses[?(@['type']=='HOME')]"259 ]260 },261 {262 "op": "ALL_OF",263 "attributes": [264 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].citizenship",265 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].names[?(@['type']=='LEGAL')]",266 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].birth_details.date_of_birth",267 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].addresses[?(@['type']=='HOME')]"268 ]269 },270 {271 "op": "ALL_OF",272 "attributes": [273 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].citizenship",274 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].names[?(@['type']=='LEGAL')]",275 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].birth_details.date_of_birth",276 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].addresses[?(@['type']=='HOME')]"277 ]278 },279 {280 "op": "ALL_OF",281 "attributes": [282 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].citizenship",283 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].names[?(@['type']=='LEGAL')]",284 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].birth_details.date_of_birth",285 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].addresses[?(@['type']=='HOME')]"286 ]287 },288 {289 "op": "ALL_OF",290 "attributes": [291 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].citizenship",292 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].percentage_of_ownership",293 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].names[?(@['type']=='LEGAL')]",294 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].birth_details.date_of_birth",295 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].addresses[?(@['type']=='HOME')]"296 ]297 },298 {299 "op": "ALL_OF",300 "attributes": [301 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].citizenship",302 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].names[?(@['type']=='LEGAL')]",303 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].birth_details.date_of_birth",304 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].addresses[?(@['type']=='HOME')]"305 ]306 }307 ]308 },309 "$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].citizenship",310 "$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].names[?(@['type']=='LEGAL')]",311 "$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].birth_details.date_of_birth"312 ]313 }314 }315 ]316 },317 "links": [318 {319 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/23PC3HNADFP2J",320 "rel": "self",321 "method": "GET"322 },323 {324 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/23PC3HNADFP2J",325 "rel": "edit",326 "method": "PATCH"327 }328 ]329}
Note: Even if SEND_MONEY is active, the merchants cannot send money.
Limits on Capabilities
Merchants conduct transactions up to specified amounts even if they fail electronic verification. If the capabilities array in the response shows a limit, the merchant can still use the capability with limits despite failing the electronic verification.
The limit in the response includes both the total limit amount and the remaining amount. If there is a time limit associated with the limit, the grace_periods array lists the start and end times of the grace period.
The types of limits may vary based on the country:
Limits in the US
Know Your Customer (KYC) and Beneficial Owner (BO) data collection and verification is mandatory in the US. If these checks don't pass, PayPal places different limits on the account.
Here are the KYC verification and BO verification sample responses:
- Sample response with $5000 limit with incomplete KYC verification
- Sample response with $500,000 limit with incomplete KYC and BO verification
|
Process Name |
Name as it appears in the API |
Restriction |
|
KYC Verification |
|
PayPal blocks all withdrawals and limits the cumulative amount received to $5,000.00 in transactions or 30 days from the account creation date, whichever comes first. |
|
Beneficial Owner Verification |
|
PayPal limits the cumulative amount received in transactions to $5,000.00. PayPal blocks all withdrawals and transactions after the merchant account reaches this limit. |
The Know Your Customer (KYC) and Beneficial Ownership (BO) procedures are standard verification processes that ensure compliance with local regulations. For Beneficial Ownership verification, all business stakeholders associated with the business, such as beneficial owners and Control Prong representatives, submit data for verification.
This process applies to all legal business entities except government entities and public companies.
PayPal must verify:
- Ownership Prong (Beneficial Owners): Up to 4 individuals who own 25% or more of the business, directly or indirectly.
- Control Prong (Office Bearers): 1 person who controls the business's day-to-day operations, such as C-level executives or someone authorized to make decisions on behalf of the business.
Sample response for account with $5000 limit
1{2 "account_id": "5J5BPEQEWPT9W",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "5J5BPEQEWPT9W",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "3C7DGY7398H8S",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "2211 N First St ",18 "address_line_2": "Unit 2000",19 "admin_area_2": "San Jose",20 "admin_area_1": "CA",21 "postal_code": "95134",22 "country_code": "US"23 },24 "phone_numbers": [25 {26 "country_code": "030",27 "national_number": "6151175",28 "id": "JUXDGWSN5FVMU",29 "type": "MOBILE"30 }31 ],32 "birth_details": {33 "date_of_birth": "1995-08-01"34 },35 "identification_documents": [36 {37 "id": "F8W3FY42CQ7RE",38 "identification_number": "****",39 "issuing_country_code": "US",40 "type": "SOCIAL_SECURITY_NUMBER"41 }42 ],43 "emails": [44 {45 "id": "WDK3MDC9WL29N",46 "email": "levin-personal-email@paypal.com"47 }48 ]49 }50 ],51 "business_entity": {52 "type": "CORPORATION",53 "merchant_category_code": "5933",54 "incorporation_details": {},55 "names": [56 {57 "business_name": "Fintech Unicorn",58 "id": "GRYKNEVWFK9EW",59 "type": "LEGAL"60 }61 ],62 "emails": [63 {64 "id": "78ABNEKQVAT8S",65 "email": "levin-business-email@paypal.com"66 }67 ],68 "website_info": {69 "website_exists": true,70 "website_url": "https://developer.paypal.com/docs/multiparty/"71 },72 "registered_business_address": {73 "address_line_1": "2211 N First St ",74 "address_line_2": "Unit 1300",75 "admin_area_2": "San Jose",76 "admin_area_1": "CA",77 "postal_code": "95134",78 "country_code": "US"79 },80 "phone_numbers": [81 {82 "country_code": "1",83 "national_number": "06151188",84 "id": "LYBZFCBJKKQRQ",85 "type": "BUSINESS"86 }87 ],88 "identification_documents": [89 {90 "id": "ACXWRURL73MB6",91 "identification_number": "****",92 "issuing_country_code": "US",93 "type": "EMPLOYER_IDENTIFICATION_NUMBER"94 }95 ],96 "beneficial_owners": {97 "individuals": [98 {99 "id": "2EP33U5BZK2XY",100 "names": [101 {102 "given_name": "Lucas",103 "surname": "Li",104 "id": "6T4P6E74PPJXJ",105 "type": "LEGAL"106 }107 ],108 "citizenship": "US",109 "addresses": [110 {111 "address_line_1": "2211 N First St ",112 "address_line_2": "Unit 2100",113 "admin_area_2": "San Jose",114 "admin_area_1": "CA",115 "postal_code": "95134",116 "country_code": "US",117 "id": "9WX6RX44J9W9U",118 "type": "HOME"119 }120 ],121 "phone_numbers": [122 {123 "country_code": "1",124 "national_number": "06151188",125 "id": "M9W369B3KN85W",126 "type": "WORK"127 }128 ],129 "birth_details": {130 "date_of_birth": "1990-01-01"131 },132 "identification_documents": [133 {134 "id": "4HRQRUY8WYSQC",135 "identification_number": "****",136 "issuing_country_code": "US",137 "type": "SOCIAL_SECURITY_NUMBER"138 }139 ],140 "emails": [141 {142 "email": "lucas-personal-email@gmail.com"143 }144 ],145 "percentage_of_ownership": "30",146 "controlling_influence": false147 }148 ]149 },150 "office_bearers": [151 {152 "id": "UEHFS3WLU8QPL",153 "names": [154 {155 "given_name": "Alexei",156 "surname": "Coreiba",157 "id": "YVJS8CBDXY5JS",158 "type": "LEGAL"159 }160 ],161 "citizenship": "US",162 "addresses": [163 {164 "address_line_1": "2211 N First St ",165 "address_line_2": "Unit 2123",166 "admin_area_2": "San Jose",167 "admin_area_1": "CA",168 "postal_code": "95134",169 "country_code": "US",170 "id": "WUXE77KTMRNLQ",171 "type": "HOME"172 }173 ],174 "phone_numbers": [175 {176 "country_code": "1",177 "national_number": "06151188",178 "id": "VY6DGWL3CDWHU",179 "type": "WORK"180 }181 ],182 "birth_details": {183 "date_of_birth": "1990-01-01"184 },185 "identification_documents": [186 {187 "id": "NCAC2QC27V5B8",188 "identification_number": "****",189 "issuing_country_code": "US",190 "type": "SOCIAL_SECURITY_NUMBER"191 }192 ],193 "emails": [194 {195 "email": "alexei-email@gmail.com"196 }197 ]198 }199 ],200 "declarations": [201 {202 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",203 "value": "YES"204 }205 ]206 },207 "agreements": [208 {209 "type": "TERMS_ACCEPTED",210 "accepted_time": "2024-01-01T00:00:00Z"211 }212 ],213 "balances": [214 {215 "available_balances": [216 {217 "currency_code": "USD",218 "value": "0.00"219 }220 ],221 "available": {222 "currency_code": "USD",223 "value": "0.00"224 },225 "reserved": {226 "currency_code": "USD",227 "value": "0.00"228 }229 }230 ],231 "external_id": "EXT-1707161355",232 "organization": "us_org/net",233 "user_id": "1707161354908",234 "primary_currency_code": "USD",235 "soft_descriptor": "FINTECHUNICORN",236 "capabilities": [237 {238 "name": "APPLE_PAY",239 "limits": [240 {241 "type": "AMOUNT",242 "unit": "USD",243 "value": "5000.00",244 "remaining_value": "5000.00",245 "implication_of_limit_breach": "BLOCK_CAPABILITY"246 }247 ],248 "grace_periods": [249 {250 "start_time": "2024-02-05T19:29:41.963Z",251 "expiry_time": "2024-03-06T19:29:41.963Z"252 }253 ],254 "status": "ACTIVE"255 },256 {257 "name": "GOOGLE_PAY",258 "limits": [259 {260 "type": "AMOUNT",261 "unit": "USD",262 "value": "5000.00",263 "remaining_value": "5000.00",264 "implication_of_limit_breach": "BLOCK_CAPABILITY"265 }266 ],267 "grace_periods": [268 {269 "start_time": "2024-02-05T19:29:41.963Z",270 "expiry_time": "2024-03-06T19:29:41.963Z"271 }272 ],273 "status": "ACTIVE"274 },275 {276 "name": "CUSTOM_CARD_PROCESSING",277 "limits": [278 {279 "type": "AMOUNT",280 "unit": "USD",281 "value": "5000.00",282 "remaining_value": "5000.00",283 "implication_of_limit_breach": "BLOCK_CAPABILITY"284 }285 ],286 "grace_periods": [287 {288 "start_time": "2024-02-05T19:29:41.963Z",289 "expiry_time": "2024-03-06T19:29:41.963Z"290 }291 ],292 "status": "ACTIVE"293 },294 {295 "name": "RECEIVE_MONEY",296 "limits": [297 {298 "type": "AMOUNT",299 "unit": "USD",300 "value": "5000.00",301 "remaining_value": "5000.00",302 "implication_of_limit_breach": "BLOCK_CAPABILITY"303 }304 ],305 "grace_periods": [306 {307 "start_time": "2024-02-05T19:29:41.963Z",308 "expiry_time": "2024-03-06T19:29:41.963Z"309 }310 ],311 "status": "ACTIVE"312 },313 {314 "name": "WITHDRAW_MONEY",315 "status": "NEED_DATA"316 }317 ],318 "process_view": {319 "processes": [320 {321 "name": "MANAGED_PATH_KYC_VERIFICATION",322 "status": "NEED_MORE_DATA",323 "capabilities": [324 {325 "name": "CUSTOM_CARD_PROCESSING",326 "limits": [327 {328 "type": "AMOUNT",329 "unit": "USD",330 "value": "5000.00",331 "remaining_value": "5000.00",332 "implication_of_limit_breach": "BLOCK_CAPABILITY"333 }334 ],335 "grace_periods": [336 {337 "start_time": "2024-02-05T19:29:41.963Z",338 "expiry_time": "2024-03-06T19:29:41.963Z"339 }340 ]341 },342 {343 "name": "RECEIVE_MONEY",344 "limits": [345 {346 "type": "AMOUNT",347 "unit": "USD",348 "value": "5000.00",349 "remaining_value": "5000.00",350 "implication_of_limit_breach": "BLOCK_CAPABILITY"351 }352 ],353 "grace_periods": [354 {355 "start_time": "2024-02-05T19:29:41.963Z",356 "expiry_time": "2024-03-06T19:29:41.963Z"357 }358 ]359 },360 {361 "name": "WITHDRAW_MONEY"362 },363 {364 "name": "APPLE_PAY",365 "limits": [366 {367 "type": "AMOUNT",368 "unit": "USD",369 "value": "5000.00",370 "remaining_value": "5000.00",371 "implication_of_limit_breach": "BLOCK_CAPABILITY"372 }373 ],374 "grace_periods": [375 {376 "start_time": "2024-02-05T19:29:41.963Z",377 "expiry_time": "2024-03-06T19:29:41.963Z"378 }379 ]380 },381 {382 "name": "GOOGLE_PAY",383 "limits": [384 {385 "type": "AMOUNT",386 "unit": "USD",387 "value": "5000.00",388 "remaining_value": "5000.00",389 "implication_of_limit_breach": "BLOCK_CAPABILITY"390 }391 ],392 "grace_periods": [393 {394 "start_time": "2024-02-05T19:29:41.963Z",395 "expiry_time": "2024-03-06T19:29:41.963Z"396 }397 ]398 }399 ],400 "required": {401 "op": "ALL_OF",402 "attributes": [403 {404 "op": "ONE_OF",405 "attributes": [406 "22045",407 "7a796",408 "173f8",409 "2fbb0",410 "72bba"411 ]412 },413 {414 "op": "ONE_OF",415 "attributes": [416 "1a833",417 "1c10c",418 "b7604",419 "27580"420 ]421 },422 "6809d"423 ]424 }425 },426 {427 "name": "MANAGED_PATH_BO_VERIFICATION",428 "status": "COMPLETED",429 "capabilities": [430 {431 "name": "WITHDRAW_MONEY"432 },433 {434 "name": "RECEIVE_MONEY"435 },436 {437 "name": "APPLE_PAY"438 },439 {440 "name": "GOOGLE_PAY"441 },442 {443 "name": "CUSTOM_CARD_PROCESSING"444 }445 ]446 },447 {448 "name": "MANAGED_PATH_KYC_COLLECTION",449 "status": "COMPLETED",450 "capabilities": [451 {452 "name": "RECEIVE_MONEY"453 },454 {455 "name": "WITHDRAW_MONEY"456 },457 {458 "name": "GOOGLE_PAY"459 },460 {461 "name": "CUSTOM_CARD_PROCESSING"462 },463 {464 "name": "APPLE_PAY"465 }466 ]467 },468 {469 "name": "MANAGED_PATH_BO_COLLECTION",470 "status": "COMPLETED",471 "capabilities": [472 {473 "name": "GOOGLE_PAY"474 },475 {476 "name": "APPLE_PAY"477 },478 {479 "name": "WITHDRAW_MONEY"480 },481 {482 "name": "CUSTOM_CARD_PROCESSING"483 },484 {485 "name": "RECEIVE_MONEY"486 }487 ]488 }489 ],490 "required_documents": [491 {492 "id": "6809d",493 "name": "BUSINESS_EXISTENCE",494 "entity": "$.business_entity",495 "links": [496 {497 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",498 "rel": "upload",499 "method": "POST"500 }501 ]502 },503 {504 "id": "72bba",505 "name": "BUSINESS_LICENSE",506 "entity": "$.business_entity",507 "links": [508 {509 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",510 "rel": "upload",511 "method": "POST"512 }513 ]514 },515 {516 "id": "27580",517 "name": "USIRS_EIN_ALLOCATION_LETTER",518 "entity": "$.business_entity",519 "links": [520 {521 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",522 "rel": "upload",523 "method": "POST"524 }525 ]526 },527 {528 "id": "b7604",529 "name": "BUSINESS_INCOME_TAX_RETURN",530 "entity": "$.business_entity",531 "links": [532 {533 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",534 "rel": "upload",535 "method": "POST"536 }537 ]538 },539 {540 "id": "22045",541 "name": "TAX_ASSESSMENT_NOTICE",542 "entity": "$.business_entity",543 "links": [544 {545 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",546 "rel": "upload",547 "method": "POST"548 }549 ]550 },551 {552 "id": "7a796",553 "name": "UTILITIES_BILL",554 "entity": "$.business_entity",555 "links": [556 {557 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",558 "rel": "upload",559 "method": "POST"560 }561 ]562 },563 {564 "id": "1a833",565 "name": "USIRS_NAME_CHANGE_LETTER",566 "entity": "$.business_entity",567 "links": [568 {569 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",570 "rel": "upload",571 "method": "POST"572 }573 ]574 },575 {576 "id": "173f8",577 "name": "INSURANCE_STATEMENT",578 "entity": "$.business_entity",579 "links": [580 {581 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",582 "rel": "upload",583 "method": "POST"584 }585 ]586 },587 {588 "id": "1c10c",589 "name": "BANK_STATEMENT",590 "entity": "$.business_entity",591 "links": [592 {593 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",594 "rel": "upload",595 "method": "POST"596 }597 ]598 },599 {600 "id": "2fbb0",601 "name": "CC_STATEMENT",602 "entity": "$.business_entity",603 "links": [604 {605 "href": "https://msmaster1int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/00ce6bff-5f4f-4eac-ae1f-7fc1b6ddc847/upload",606 "rel": "upload",607 "method": "POST"608 }609 ]610 }611 ]612 },613 "links": [614 {615 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/5J5BPEQEWPT9W",616 "rel": "self",617 "method": "GET"618 },619 {620 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/5J5BPEQEWPT9W",621 "rel": "edit",622 "method": "PATCH"623 },624 {625 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/5J5BPEQEWPT9W/wallet-domains?page=1",626 "rel": "wallet-domains",627 "method": "GET"628 }629 ]630}
In this example, the merchant can transact for $5,000 more dollars or 30 more days, whichever comes first. When building your UI, show both values to the merchant.
Sample response for account with $500,000 limit
1{2 "account_id": "VS5LLPA9KC3JJ",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "VS5LLPA9KC3JJ",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "ZASLDNDUSPJUW",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "2211 N First St ",18 "address_line_2": "Unit 2000",19 "admin_area_2": "San Jose",20 "admin_area_1": "CA",21 "postal_code": "95134",22 "country_code": "US"23 },24 "phone_numbers": [25 {26 "country_code": "030",27 "national_number": "6151175",28 "id": "Q6K8CUKG5AKCG",29 "type": "MOBILE"30 }31 ],32 "birth_details": {33 "date_of_birth": "1995-08-01"34 },35 "identification_documents": [36 {37 "id": "22V4VGNN6FV8J",38 "identification_number": "****",39 "issuing_country_code": "US",40 "type": "SOCIAL_SECURITY_NUMBER"41 }42 ],43 "emails": [44 {45 "id": "XRVVHPAXETTKU",46 "email": "levin-personal-email@paypal.com"47 }48 ]49 }50 ],51 "business_entity": {52 "type": "CORPORATION",53 "merchant_category_code": "5933",54 "incorporation_details": {},55 "names": [56 {57 "business_name": "DECLINED",58 "id": "NKGTBF6QWGKLU",59 "type": "LEGAL"60 }61 ],62 "emails": [63 {64 "id": "L666EU4QXHPAS",65 "email": "levin-business-email@paypal.com"66 }67 ],68 "website_info": {69 "website_exists": true,70 "website_url": "https://developer.paypal.com/docs/multiparty/"71 },72 "registered_business_address": {73 "address_line_1": "2211 N First St ",74 "address_line_2": "Unit 1300",75 "admin_area_2": "San Jose",76 "admin_area_1": "CA",77 "postal_code": "95134",78 "country_code": "US"79 },80 "phone_numbers": [81 {82 "country_code": "1",83 "national_number": "06151188",84 "id": "A2EY3WUGCE2DW",85 "type": "BUSINESS"86 }87 ],88 "identification_documents": [89 {90 "id": "BW9AMRFZUHMXU",91 "identification_number": "****",92 "issuing_country_code": "US",93 "type": "EMPLOYER_IDENTIFICATION_NUMBER"94 }95 ],96 "beneficial_owners": {97 "individuals": [98 {99 "id": "P9MDPQCP6TUDN",100 "names": [101 {102 "given_name": "Lucas DECLINED",103 "surname": "Li DECLINED",104 "id": "B79ZVE39VHS4J",105 "type": "LEGAL"106 }107 ],108 "citizenship": "US",109 "addresses": [110 {111 "address_line_1": "2211 N First St ",112 "address_line_2": "Unit 2100",113 "admin_area_2": "San Jose",114 "admin_area_1": "CA",115 "postal_code": "95134",116 "country_code": "US",117 "id": "REQTZ5USBDBNL",118 "type": "HOME"119 }120 ],121 "phone_numbers": [122 {123 "country_code": "1",124 "national_number": "06151188",125 "id": "VF3RHVAG63YT8",126 "type": "WORK"127 }128 ],129 "birth_details": {130 "date_of_birth": "1990-01-01"131 },132 "identification_documents": [133 {134 "id": "BDM7J5T3SAV22",135 "identification_number": "****",136 "issuing_country_code": "US",137 "type": "SOCIAL_SECURITY_NUMBER"138 }139 ],140 "emails": [141 {142 "email": "lucas-personal-email@gmail.com"143 }144 ],145 "percentage_of_ownership": "30",146 "controlling_influence": false147 }148 ]149 },150 "office_bearers": [151 {152 "id": "FYQQRRY3GR2FN",153 "names": [154 {155 "given_name": "Alexei DECLINED",156 "surname": "Coreiba DECLINED",157 "id": "8XQN7DMTYSQD6",158 "type": "LEGAL"159 }160 ],161 "citizenship": "US",162 "addresses": [163 {164 "address_line_1": "2211 N First St ",165 "address_line_2": "Unit 2123",166 "admin_area_2": "San Jose",167 "admin_area_1": "CA",168 "postal_code": "95134",169 "country_code": "US",170 "id": "DEBZMB4JCJTJA",171 "type": "HOME"172 }173 ],174 "phone_numbers": [175 {176 "country_code": "1",177 "national_number": "06151188",178 "id": "PE4KEUCDNAPVL",179 "type": "WORK"180 }181 ],182 "birth_details": {183 "date_of_birth": "1990-01-01"184 },185 "identification_documents": [186 {187 "id": "WWLUUDEFNBBEC",188 "identification_number": "****",189 "issuing_country_code": "US",190 "type": "SOCIAL_SECURITY_NUMBER"191 }192 ],193 "emails": [194 {195 "email": "alexei-email@gmail.com"196 }197 ]198 }199 ],200 "declarations": [201 {202 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",203 "value": "YES"204 }205 ]206 },207 "agreements": [208 {209 "type": "TERMS_ACCEPTED",210 "accepted_time": "2024-01-01T00:00:00Z"211 }212 ],213 "balances": [214 {215 "available_balances": [216 {217 "currency_code": "USD",218 "value": "0.00"219 }220 ],221 "available": {222 "currency_code": "USD",223 "value": "0.00"224 },225 "reserved": {226 "currency_code": "USD",227 "value": "0.00"228 }229 }230 ],231 "external_id": "EXT-1707165609",232 "organization": "us_org/net",233 "user_id": "1707165608814",234 "primary_currency_code": "USD",235 "soft_descriptor": "DECLINED",236 "capabilities": [237 {238 "name": "APPLE_PAY",239 "limits": [240 {241 "type": "AMOUNT",242 "unit": "USD",243 "value": "5000.00",244 "remaining_value": "5000.00",245 "implication_of_limit_breach": "BLOCK_CAPABILITY"246 }247 ],248 "grace_periods": [249 {250 "start_time": "2024-02-05T20:40:37.110Z",251 "expiry_time": "2024-03-06T20:40:37.110Z"252 }253 ],254 "status": "ACTIVE"255 },256 {257 "name": "GOOGLE_PAY",258 "limits": [259 {260 "type": "AMOUNT",261 "unit": "USD",262 "value": "5000.00",263 "remaining_value": "5000.00",264 "implication_of_limit_breach": "BLOCK_CAPABILITY"265 }266 ],267 "grace_periods": [268 {269 "start_time": "2024-02-05T20:40:37.110Z",270 "expiry_time": "2024-03-06T20:40:37.110Z"271 }272 ],273 "status": "ACTIVE"274 },275 {276 "name": "CUSTOM_CARD_PROCESSING",277 "limits": [278 {279 "type": "AMOUNT",280 "unit": "USD",281 "value": "5000.00",282 "remaining_value": "5000.00",283 "implication_of_limit_breach": "BLOCK_CAPABILITY"284 }285 ],286 "grace_periods": [287 {288 "start_time": "2024-02-05T20:40:37.110Z",289 "expiry_time": "2024-03-06T20:40:37.110Z"290 }291 ],292 "status": "ACTIVE"293 },294 {295 "name": "RECEIVE_MONEY",296 "limits": [297 {298 "type": "AMOUNT",299 "unit": "USD",300 "value": "5000.00",301 "remaining_value": "5000.00",302 "implication_of_limit_breach": "BLOCK_CAPABILITY"303 }304 ],305 "grace_periods": [306 {307 "start_time": "2024-02-05T20:40:37.110Z",308 "expiry_time": "2024-03-06T20:40:37.110Z"309 }310 ],311 "status": "ACTIVE"312 },313 {314 "name": "WITHDRAW_MONEY",315 "status": "NEED_DATA"316 }317 ],318 "process_view": {319 "processes": [320 {321 "name": "MANAGED_PATH_KYC_VERIFICATION",322 "status": "NEED_MORE_DATA",323 "capabilities": [324 {325 "name": "RECEIVE_MONEY",326 "limits": [327 {328 "type": "AMOUNT",329 "unit": "USD",330 "value": "5000.00",331 "remaining_value": "5000.00",332 "implication_of_limit_breach": "BLOCK_CAPABILITY"333 }334 ],335 "grace_periods": [336 {337 "start_time": "2024-02-05T20:40:37.110Z",338 "expiry_time": "2024-03-06T20:40:37.110Z"339 }340 ]341 },342 {343 "name": "CUSTOM_CARD_PROCESSING",344 "limits": [345 {346 "type": "AMOUNT",347 "unit": "USD",348 "value": "5000.00",349 "remaining_value": "5000.00",350 "implication_of_limit_breach": "BLOCK_CAPABILITY"351 }352 ],353 "grace_periods": [354 {355 "start_time": "2024-02-05T20:40:37.110Z",356 "expiry_time": "2024-03-06T20:40:37.110Z"357 }358 ]359 },360 {361 "name": "WITHDRAW_MONEY"362 },363 {364 "name": "GOOGLE_PAY",365 "limits": [366 {367 "type": "AMOUNT",368 "unit": "USD",369 "value": "5000.00",370 "remaining_value": "5000.00",371 "implication_of_limit_breach": "BLOCK_CAPABILITY"372 }373 ],374 "grace_periods": [375 {376 "start_time": "2024-02-05T20:40:37.110Z",377 "expiry_time": "2024-03-06T20:40:37.110Z"378 }379 ]380 },381 {382 "name": "APPLE_PAY",383 "limits": [384 {385 "type": "AMOUNT",386 "unit": "USD",387 "value": "5000.00",388 "remaining_value": "5000.00",389 "implication_of_limit_breach": "BLOCK_CAPABILITY"390 }391 ],392 "grace_periods": [393 {394 "start_time": "2024-02-05T20:40:37.110Z",395 "expiry_time": "2024-03-06T20:40:37.110Z"396 }397 ]398 }399 ],400 "required": {401 "op": "ALL_OF",402 "attributes": [403 {404 "op": "ONE_OF",405 "attributes": [406 "3559c",407 "cff47",408 "3af36",409 "81743",410 "42d50"411 ]412 },413 {414 "op": "ONE_OF",415 "attributes": [416 "e9366",417 "ec8c1",418 "c3612",419 "640b4"420 ]421 },422 "e1ee7"423 ]424 }425 },426 {427 "name": "MANAGED_PATH_BO_VERIFICATION",428 "status": "NEED_MORE_DATA",429 "capabilities": [430 {431 "name": "APPLE_PAY",432 "limits": [433 {434 "type": "AMOUNT",435 "unit": "USD",436 "value": "500000.00",437 "remaining_value": "500000.00",438 "implication_of_limit_breach": "BLOCK_CAPABILITY"439 }440 ]441 },442 {443 "name": "CUSTOM_CARD_PROCESSING",444 "limits": [445 {446 "type": "AMOUNT",447 "unit": "USD",448 "value": "500000.00",449 "remaining_value": "500000.00",450 "implication_of_limit_breach": "BLOCK_CAPABILITY"451 }452 ]453 },454 {455 "name": "RECEIVE_MONEY",456 "limits": [457 {458 "type": "AMOUNT",459 "unit": "USD",460 "value": "500000.00",461 "remaining_value": "500000.00",462 "implication_of_limit_breach": "BLOCK_CAPABILITY"463 }464 ]465 },466 {467 "name": "GOOGLE_PAY",468 "limits": [469 {470 "type": "AMOUNT",471 "unit": "USD",472 "value": "500000.00",473 "remaining_value": "500000.00",474 "implication_of_limit_breach": "BLOCK_CAPABILITY"475 }476 ]477 },478 {479 "name": "WITHDRAW_MONEY",480 "limits": [481 {482 "type": "AMOUNT",483 "unit": "USD",484 "value": "500000.00",485 "remaining_value": "500000.00",486 "implication_of_limit_breach": "BLOCK_CAPABILITY"487 }488 ]489 }490 ],491 "required": {492 "op": "ALL_OF",493 "attributes": [494 "cb54e",495 "a6185"496 ]497 }498 },499 {500 "name": "MANAGED_PATH_BO_COLLECTION",501 "status": "COMPLETED",502 "capabilities": [503 {504 "name": "CUSTOM_CARD_PROCESSING"505 },506 {507 "name": "RECEIVE_MONEY"508 },509 {510 "name": "APPLE_PAY"511 },512 {513 "name": "WITHDRAW_MONEY"514 },515 {516 "name": "GOOGLE_PAY"517 }518 ]519 },520 {521 "name": "MANAGED_PATH_KYC_COLLECTION",522 "status": "COMPLETED",523 "capabilities": [524 {525 "name": "APPLE_PAY"526 },527 {528 "name": "CUSTOM_CARD_PROCESSING"529 },530 {531 "name": "WITHDRAW_MONEY"532 },533 {534 "name": "GOOGLE_PAY"535 },536 {537 "name": "RECEIVE_MONEY"538 }539 ]540 }541 ],542 "required_documents": [543 {544 "id": "e1ee7",545 "name": "BUSINESS_EXISTENCE",546 "entity": "$.business_entity",547 "links": [548 {549 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",550 "rel": "upload",551 "method": "POST"552 }553 ]554 },555 {556 "id": "42d50",557 "name": "BUSINESS_LICENSE",558 "entity": "$.business_entity",559 "links": [560 {561 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",562 "rel": "upload",563 "method": "POST"564 }565 ]566 },567 {568 "id": "640b4",569 "name": "USIRS_EIN_ALLOCATION_LETTER",570 "entity": "$.business_entity",571 "links": [572 {573 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",574 "rel": "upload",575 "method": "POST"576 }577 ]578 },579 {580 "id": "c3612",581 "name": "BUSINESS_INCOME_TAX_RETURN",582 "entity": "$.business_entity",583 "links": [584 {585 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",586 "rel": "upload",587 "method": "POST"588 }589 ]590 },591 {592 "id": "3559c",593 "name": "TAX_ASSESSMENT_NOTICE",594 "entity": "$.business_entity",595 "links": [596 {597 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",598 "rel": "upload",599 "method": "POST"600 }601 ]602 },603 {604 "id": "cff47",605 "name": "UTILITIES_BILL",606 "entity": "$.business_entity",607 "links": [608 {609 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",610 "rel": "upload",611 "method": "POST"612 }613 ]614 },615 {616 "id": "e9366",617 "name": "USIRS_NAME_CHANGE_LETTER",618 "entity": "$.business_entity",619 "links": [620 {621 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",622 "rel": "upload",623 "method": "POST"624 }625 ]626 },627 {628 "id": "3af36",629 "name": "INSURANCE_STATEMENT",630 "entity": "$.business_entity",631 "links": [632 {633 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",634 "rel": "upload",635 "method": "POST"636 }637 ]638 },639 {640 "id": "ec8c1",641 "name": "BANK_STATEMENT",642 "entity": "$.business_entity",643 "links": [644 {645 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",646 "rel": "upload",647 "method": "POST"648 }649 ]650 },651 {652 "id": "a6185",653 "name": "SOCIAL_SECURITY_NUMBER",654 "entity": "$.business_entity.office_bearers[?(@['id']=='FYQQRRY3GR2FN')]",655 "links": [656 {657 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/54a907dc-66f7-424f-a568-a7aa9ef0af76/upload",658 "rel": "upload",659 "method": "POST"660 }661 ]662 },663 {664 "id": "81743",665 "name": "CC_STATEMENT",666 "entity": "$.business_entity",667 "links": [668 {669 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",670 "rel": "upload",671 "method": "POST"672 }673 ]674 },675 {676 "id": "cb54e",677 "name": "SOCIAL_SECURITY_NUMBER",678 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='P9MDPQCP6TUDN')]",679 "links": [680 {681 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/eca7fa47-6c71-42c7-b044-4abd6ecc2ed4/upload",682 "rel": "upload",683 "method": "POST"684 }685 ]686 }687 ]688 },689 "links": [690 {691 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ",692 "rel": "self",693 "method": "GET"694 },695 {696 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ",697 "rel": "edit",698 "method": "PATCH"699 },700 {701 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ/wallet-domains?page=1",702 "rel": "wallet-domains",703 "method": "GET"704 }705 ]706}
Note: If multiple counters show up for a single capability:
- Different Units: If the counters represent different units, such as days and dollars, show them to your merchants on your UI. For example, show both if the customer has x days or $y to complete verification. The customer must finish verification before either the time or limit is reached, whichever comes first.
- Same Unit: If the counters have the same unit, for example, both in dollars, show only the lowest value. This option ensures the merchant knows they have the lesser of the two amounts, $x or $y, to complete the verification process.
Limits in Europe and the UK
Know Your Customer (KYC) and Beneficial Owner (BO) data collection and verification is mandatory in Europe and in the UK.
|
Process name |
Name as it appears in the API |
Restriction |
|
KYC and Beneficial Owner Verification
|
|
PayPal limits the cumulative received amount to €1,000/£1,000 in transactions. PayPal blocks withdrawals and transactions after the amount reaches the limit.
|
These limitations appear in the capabilities section of the response.
Sample response for account with €1,000 limit
1{23 "account_id": "USZJERXL88TDL",45 "legal_country_code": "FR",67 "individual_owners": [89 {1011 "id": "USZJERXL88TDL",1213 "names": [1415 {1617 "given_name": "Levin",1819 "surname": "Huang",2021 "id": "5YQX3KBKL7T4S",2223 "type": "LEGAL"2425 }2627 ],2829 "citizenship": "FR",3031 "primary_residence": {3233 "address_line_1": "24 rue du Faubourg Saint Honore",3435 "address_line_2": "Unit 2000",3637 "admin_area_2": "Paris",3839 "postal_code": "75008",4041 "country_code": "FR"4243 },4445 "phone_numbers": [4647 {4849 "country_code": "030",5051 "national_number": "6151175",5253 "id": "WNBMJ2MH49GV8",5455 "type": "MOBILE"5657 }5859 ],6061 "birth_details": {6263 "date_of_birth": "1995-08-01"6465 },6667 "identification_documents": [6869 {7071 "id": "XVZWDF8XJ4E56",7273 "identification_number": "****",7475 "issuing_country_code": "FR",7677 "type": "PASSPORT"7879 }8081 ],8283 "emails": [8485 {8687 "id": "ZGQNPZAHLT2M2",8889 "email": "levin-personal-email@paypal.com"9091 }9293 ]9495 }9697 ],9899 "business_entity": {100101 "type": "CORPORATION",102103 "merchant_category_code": "5933",104105 "incorporation_details": {106107 "incorporation_country_code": "FR",108109 "incorporation_date": "1999-01-10"110111 },112113 "names": [114115 {116117 "business_name": "Fintech Unicorn",118119 "id": "JYP26SH5ZMRS2",120121 "type": "LEGAL"122123 }124125 ],126127 "emails": [128129 {130131 "id": "EMHQK8MS2E5HL",132133 "email": "levin-business-email@paypal.com"134135 }136137 ],138139 "website": "https://developer.paypal.com/docs/multiparty/",140141 "registered_business_address": {142143 "address_line_1": "24 rue du Faubourg Saint Honore",144145 "address_line_2": "Unit 2100",146147 "admin_area_2": "Paris",148149 "postal_code": "75008",150151 "country_code": "FR"152153 },154155 "phone_numbers": [156157 {158159 "country_code": "1",160161 "national_number": "06151188",162163 "id": "PGYBZUPJAD6D2",164165 "type": "BUSINESS"166167 }168169 ],170171 "identification_documents": [172173 {174175 "id": "QHQ8W2T3DN4V2",176177 "identification_number": "****",178179 "issuing_country_code": "FR",180181 "type": "BUSINESS_REGISTRATION_NUMBER"182183 }184185 ],186187 "beneficial_owners": {188189 "individuals": [190191 {192193 "id": "UJGR6DTJH5QDS",194195 "names": [196197 {198199 "given_name": "Lucas",200201 "surname": "Li",202203 "id": "JP8BTRPBFJJSY",204205 "type": "LEGAL"206207 }208209 ],210211 "citizenship": "FR",212213 "addresses": [214215 {216217 "address_line_1": "24 rue du Faubourg Saint Honore",218219 "address_line_2": "Unit 2200",220221 "admin_area_2": "Paris",222223 "postal_code": "75008",224225 "country_code": "FR",226227 "id": "XHNHA4FR9EXZL",228229 "type": "HOME"230231 }232233 ],234235 "phone_numbers": [236237 {238239 "country_code": "1",240241 "national_number": "06151188",242243 "id": "DX29KCM3BQ88C",244245 "type": "WORK"246247 }248249 ],250251 "birth_details": {252253 "date_of_birth": "1990-01-01"254255 },256257 "identification_documents": [258259 {260261 "id": "U2TQ26HZQCDQG",262263 "identification_number": "****",264265 "issuing_country_code": "FR",266267 "type": "NATIONAL_ID_CARD"268269 }270271 ],272273 "emails": [274275 {276277 "email": "lucas-personal-email@gmail.com"278279 }280281 ],282283 "percentage_of_ownership": "30",284285 "controlling_influence": false286287 }288289 ]290291 },292293 "office_bearers": [294295 {296297 "id": "FDT34KT4KHJQG",298299 "names": [300301 {302303 "given_name": "Alexei",304305 "surname": "Coreiba",306307 "id": "TE9Z2AG96NSY6",308309 "type": "LEGAL"310311 }312313 ],314315 "citizenship": "FR",316317 "addresses": [318319 {320321 "address_line_1": "24 rue du Faubourg Saint Honore",322323 "address_line_2": "Unit 2300",324325 "admin_area_2": "Paris",326327 "postal_code": "75008",328329 "country_code": "FR",330331 "id": "VXL3PNNNS8566",332333 "type": "HOME"334335 }336337 ],338339 "phone_numbers": [340341 {342343 "country_code": "1",344345 "national_number": "06151188",346347 "id": "FVYF6MMJC2J58",348349 "type": "WORK"350351 }352353 ],354355 "birth_details": {356357 "date_of_birth": "1990-01-01"358359 },360361 "identification_documents": [362363 {364365 "id": "WL5V3MZ53KPDE",366367 "identification_number": "****",368369 "issuing_country_code": "FR",370371 "type": "PASSPORT"372373 }374375 ],376377 "emails": [378379 {380381 "email": "alexei-email@gmail.com"382383 }384385 ],386387 "role": "DIRECTOR"388389 }390391 ],392393 "declarations": [394395 {396397 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",398399 "value": "YES"400401 }402403 ]404405 },406407 "agreements": [408409 {410411 "type": "TERMS_ACCEPTED",412413 "accepted_time": "2024-01-01T00:00:00Z"414415 }416417 ],418419 "balances": [420421 {422423 "available_balances": [424425 {426427 "currency_code": "EUR",428429 "value": "0.00"430431 }432433 ],434435 "available": {436437 "currency_code": "EUR",438439 "value": "0.00"440441 },442443 "reserved": {444445 "currency_code": "EUR",446447 "value": "0.00"448449 }450451 }452453 ],454455 "external_id": "EXT-1707163925",456457 "organization": "us_org/net",458459 "user_id": "1707163924527",460461 "primary_currency_code": "EUR",462463 "soft_descriptor": "FINTECHUNICORN",464465 "capabilities": [466467 {468469 "name": "APPLE_PAY",470471 "limits": [472473 {474475 "type": "AMOUNT",476477 "unit": "EUR",478479 "value": "1000.00",480481 "remaining_value": "1000.00",482483 "implication_of_limit_breach": "START_GRACE_PERIOD"484485 }486487 ],488489 "status": "ACTIVE"490491 },492493 {494495 "name": "GOOGLE_PAY",496497 "limits": [498499 {500501 "type": "AMOUNT",502503 "unit": "EUR",504505 "value": "1000.00",506507 "remaining_value": "1000.00",508509 "implication_of_limit_breach": "START_GRACE_PERIOD"510511 }512513 ],514515 "status": "ACTIVE"516517 },518519 {520521 "name": "CUSTOM_CARD_PROCESSING",522523 "limits": [524525 {526527 "type": "AMOUNT",528529 "unit": "EUR",530531 "value": "1000.00",532533 "remaining_value": "1000.00",534535 "implication_of_limit_breach": "START_GRACE_PERIOD"536537 }538539 ],540541 "status": "ACTIVE"542543 },544545 {546547 "name": "RECEIVE_MONEY",548549 "status": "ACTIVE"550551 },552553 {554555 "name": "WITHDRAW_MONEY",556557 "limits": [558559 {560561 "type": "AMOUNT",562563 "unit": "EUR",564565 "value": "1000.00",566567 "remaining_value": "1000.00",568569 "implication_of_limit_breach": "BLOCK_CAPABILITY"570571 }572573 ],574575 "status": "ACTIVE"576577 }578579 ],580581 "process_view": {582583 "processes": [584585 {586587 "name": "MANAGED_PATH_KYC",588589 "status": "NEED_MORE_DATA",590591 "capabilities": [592593 {594595 "name": "GOOGLE_PAY",596597 "limits": [598599 {600601 "type": "AMOUNT",602603 "unit": "EUR",604605 "value": "1000.00",606607 "remaining_value": "1000.00",608609 "implication_of_limit_breach": "START_GRACE_PERIOD"610611 }612613 ]614615 },616617 {618619 "name": "CUSTOM_CARD_PROCESSING",620621 "limits": [622623 {624625 "type": "AMOUNT",626627 "unit": "EUR",628629 "value": "1000.00",630631 "remaining_value": "1000.00",632633 "implication_of_limit_breach": "START_GRACE_PERIOD"634635 }636637 ]638639 },640641 {642643 "name": "APPLE_PAY",644645 "limits": [646647 {648649 "type": "AMOUNT",650651 "unit": "EUR",652653 "value": "1000.00",654655 "remaining_value": "1000.00",656657 "implication_of_limit_breach": "START_GRACE_PERIOD"658659 }660661 ]662663 },664665 {666667 "name": "WITHDRAW_MONEY",668669 "limits": [670671 {672673 "type": "AMOUNT",674675 "unit": "EUR",676677 "value": "1000.00",678679 "remaining_value": "1000.00",680681 "implication_of_limit_breach": "BLOCK_CAPABILITY"682683 }684685 ]686687 }688689 ],690691 "required_corrections": {692693 "op": "ALL_OF",694695 "attributes": [696697 "$.business_entity.type",698699 "$.business_entity.identification_documents[?(@['type']=='BUSINESS_REGISTRATION_NUMBER')]",700701 "$.business_entity.registered_business_address",702703 "$.business_entity.names[?(@['type']=='LEGAL')]"704705 ]706707 }708709 },710711 {712713 "name": "MANAGED_PATH_CIP_COLLECTION",714715 "status": "COMPLETED",716717 "capabilities": [718719 {720721 "name": "APPLE_PAY"722723 },724725 {726727 "name": "RECEIVE_MONEY"728729 },730731 {732733 "name": "GOOGLE_PAY"734735 },736737 {738739 "name": "CUSTOM_CARD_PROCESSING"740741 },742743 {744745 "name": "WITHDRAW_MONEY"746747 }748749 ]750751 }752753 ]754755 },756757 "links": [758759 {760761 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/USZJERXL88TDL",762763 "rel": "self",764765 "method": "GET"766767 },768769 {770771 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/USZJERXL88TDL",772773 "rel": "edit",774775 "method": "PATCH"776777 },778779 {780781 "href": "https://api.sandbox.paypal.com/v3/customer/managed-accounts/USZJERXL88TDL/wallet-domains?page=1",782783 "rel": "wallet-domains",784785 "method": "GET"786787 }788789 ]790791}
Note: You'll also see data collection policies outlined in the process view. For more information on interpreting and reacting to data collection policies, see Create merchant accounts.
Limits in Canada
Know Your Customer (KYC) and Beneficial Owner (BO) data collection and verification is mandatory in Canada.
| Process name | Name as it appears in the API | Restriction |
|
KYC and Beneficial Owner Verification
|
|
The cumulative amount received in transactions is limited to 3,000 CAD. Withdrawals are blocked after reaching the limit, and a 14-day grace period starts. When the grace period expires, transactions are blocked. Withdrawals and transactions are blocked if verification is not completed within 30 days of account creation. |
The Know Your Customer (KYC) and Beneficial Ownership procedure is a standard verification process in Canada to ensure compliance with local regulations.
For Beneficial Ownership verification, all business stakeholders associated with the business, such as beneficial owners, must submit data and be verified. In the absence of the Beneficial Owner, a company executive must submit data and be verified. PayPal also verifies the Authorized Representatives of the business. This applies to all legal business entities.
PayPal should verify the following roles:
- Beneficial Owners: Up to 4 people who directly or indirectly own 25% or more of the business.
- Office Bearers: 1 person who has control as CEO or President, or who operates in a similar position in the business.
- Authorized Representative: An individual who has signatory rights and is officially registered to act or sign on behalf of the company. PayPal requires the verification of 1 individual.
If you submit all required data but we cannot verify it automatically, limitations remain in the capabilities section until you complete the manual verification process.
Sample response for an account with C$3000 limit and with a grace period of 30 days
1"capabilities": [2 {3 "name": "APPLE_PAY",4 "limits": [5 {6 "type": "AMOUNT",7 "unit": "CAD",8 "value": "3000.00",9 "remaining_value": "3000.00",10 "implication_of_limit_breach": "START_GRACE_PERIOD"11 }12 ],13 "grace_periods": [14 {15 "start_time": "2024-10-04T18:43:13.000Z",16 "expiry_time": "2024-11-03T18:43:13Z"17 }18 ],19 "status": "ACTIVE"20 },21 {22 "name": "GOOGLE_PAY",23 "limits": [24 {25 "type": "AMOUNT",26 "unit": "CAD",27 "value": "3000.00",28 "remaining_value": "3000.00",29 "implication_of_limit_breach": "START_GRACE_PERIOD"30 }31 ],32 "grace_periods": [33 {34 "start_time": "2024-10-04T18:43:13.000Z",35 "expiry_time": "2024-11-03T18:43:13Z"36 }37 ],38 "status": "ACTIVE"39 },40 {41 "name": "CUSTOM_CARD_PROCESSING",42 "status": "NEED_DATA"43 },44 {45 "name": "RECEIVE_MONEY",46 "limits": [47 {48 "type": "AMOUNT",49 "unit": "CAD",50 "value": "3000.00",51 "remaining_value": "3000.00",52 "implication_of_limit_breach": "START_GRACE_PERIOD"53 }54 ],55 "grace_periods": [56 {57 "start_time": "2024-10-04T18:43:13.000Z",58 "expiry_time": "2024-11-03T18:43:13Z"59 }60 ],61 "status": "ACTIVE"62 },63 {64 "name": "PAYPAL_WALLET_VAULTING_ADVANCED",65 "status": "ACTIVE"66 },67 {68 "name": "WITHDRAW_MONEY",69 "limits": [70 {71 "type": "AMOUNT",72 "unit": "CAD",73 "value": "3000.00",74 "remaining_value": "3000.00",75 "implication_of_limit_breach": "BLOCK_CAPABILITY"76 }77 ],78 "grace_periods": [79 {80 "start_time": "2024-10-04T18:43:13.000Z",81 "expiry_time": "2024-11-03T18:43:13Z"82 }83 ],84 "status": "ACTIVE"85 }86 ],
In this example, the merchant can transact for $3,000 more or 30 more days, whichever comes first. When building your UI, show both values to the merchant. When building your UI, make sure to show both of these values to the customer.
- If multiple counters show up for a single capability:
- Different Units: If the counters represent different units, such as days and dollars, show them to your merchants on your UI. For example, show both if the customer has x days or $y to complete verification. The customer must finish verification before either the time or limit is reached, whichever comes first.
- Same Unit: If the counters have the same unit, for example, both in dollars, show only the lowest value. This option ensures the merchant knows they have the lesser of the two amounts, $x or $y, to complete the verification process.
- The
process_viewalso outlines Data Collection policies. For more information on interpreting and reacting to data collection policies, see Creating an account.
Analyze process_view
If the merchant does not pass the verification, use process_view to find the data elements the merchant should provide.
Specify views="process_view"in the GET request, either in the HTTP header or as a URL query parameter, to view process_view in the response. To know more about process_view, see the Structure of process_view object section.
The following sample responses highlight the verification requirements and missing elements by region:
- Information required for verification (US)
- Documents required for verification (US)
- Information required for verification (EU)
- Information needs correction (EU)
- Documents required for verification (EU)
- Documents required for verification (Canada)
- Documents required for PBS and LOA verification (Canada)
Sample response: Information required for verification (US)
The following example is a sample response when a merchant account verification needs additional information. The required object shows the data the merchant must provide to complete the verification.
1{2 "account_id": "K9K6ERAVXB47C",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "K9K6ERAVXB47C",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "GR2DQSB8HCM86",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "2211 N First St ",18 "address_line_2": "Unit 2000",19 "admin_area_2": "San Jose",20 "admin_area_1": "CA",21 "postal_code": "95134",22 "country_code": "US"23 },24 "phone_numbers": [25 {26 "country_code": "030",27 "national_number": "6151175",28 "id": "57BHQSBN3FCSW",29 "type": "MOBILE"30 }31 ],32 "birth_details": {33 "date_of_birth": "1995-08-01"34 },35 "identification_documents": [36 {37 "id": "A5UKKQXTJRTLJ",38 "identification_number": "****",39 "issuing_country_code": "US",40 "type": "SOCIAL_SECURITY_NUMBER"41 }42 ],43 "emails": [44 {45 "id": "5DANXH62N7NNJ",46 "email": "levin-personal-email@paypal.com"47 }48 ]49 }50 ],51 "business_entity": {52 "type": "CORPORATION",53 "merchant_category_code": "5933",54 "incorporation_details": {},55 "names": [56 {57 "business_name": "Fintech Unicorn",58 "id": "YGPEJS55S7PCU",59 "type": "LEGAL"60 }61 ],62 "emails": [63 {64 "id": "22NKFTHAEA2L6",65 "email": "levin-business-email@paypal.com"66 }67 ],68 "website_info": {69 "website_exists": true,70 "website_url": "https://developer.paypal.com/docs/multiparty/"71 },72 "registered_business_address": {73 "address_line_1": "2211 N First St ",74 "address_line_2": "Unit 1300",75 "admin_area_2": "San Jose",76 "admin_area_1": "CA",77 "postal_code": "95134",78 "country_code": "US"79 },80 "phone_numbers": [81 {82 "country_code": "1",83 "national_number": "06151188",84 "id": "QDNNJ3LE83BV2",85 "type": "BUSINESS"86 }87 ],88 "identification_documents": [89 {90 "id": "LPNQUBZ8TV4FW",91 "identification_number": "****",92 "issuing_country_code": "US",93 "type": "EMPLOYER_IDENTIFICATION_NUMBER"94 }95 ],96 "declarations": [97 {98 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",99 "value": "NO"100 }101 ]102 },103 "agreements": [104 {105 "type": "TERMS_ACCEPTED",106 "accepted_time": "2024-01-01T00:00:00Z"107 }108 ],109 "balances": [110 {111 "available_balances": [112 {113 "currency_code": "USD",114 "value": "0.00"115 }116 ],117 "available": {118 "currency_code": "USD",119 "value": "0.00"120 },121 "reserved": {122 "currency_code": "USD",123 "value": "0.00"124 }125 }126 ],127 "external_id": "EXT-1707166728",128 "organization": "us_org/net",129 "user_id": "1707166727984",130 "primary_currency_code": "USD",131 "soft_descriptor": "FINTECHUNIC",132 "capabilities": [133 {134 "name": "APPLE_PAY",135 "status": "NEED_DATA"136 },137 {138 "name": "GOOGLE_PAY",139 "status": "NEED_DATA"140 },141 {142 "name": "CUSTOM_CARD_PROCESSING",143 "status": "NEED_DATA"144 },145 {146 "name": "RECEIVE_MONEY",147 "status": "NEED_DATA"148 },149 {150 "name": "WITHDRAW_MONEY",151 "status": "NEED_DATA"152 }153 ],154155// process_view object156157 "process_view": {158 "processes": [159 {160 "name": "MANAGED_PATH_BO_COLLECTION",161 "status": "NEED_MORE_DATA",162 "capabilities": [163 {164 "name": "CUSTOM_CARD_PROCESSING"165 },166 {167 "name": "GOOGLE_PAY"168 },169 {170 "name": "WITHDRAW_MONEY"171 },172 {173 "name": "APPLE_PAY"174 },175 {176 "name": "RECEIVE_MONEY"177 }178 ],179 "required": {180 "op": "ALL_OF",181 "attributes": [182 "$.business_entity.office_bearers[*].citizenship",183 "$.business_entity.office_bearers[*].emails",184 "$.business_entity.office_bearers[*].names[?(@['type']=='LEGAL')]",185 "$.business_entity.office_bearers[*].birth_details.date_of_birth",186 "$.business_entity.office_bearers[*].addresses[?(@['type']=='HOME')]",187 "$.business_entity.office_bearers[*].phone_numbers[?(@['type']=='WORK')]"188 ]189 }190 },191 {192 "name": "MANAGED_PATH_BO_VERIFICATION",193 "status": "NEED_MORE_DATA",194 "capabilities": [195 {196 "name": "APPLE_PAY",197 "limits": [198 {199 "type": "AMOUNT",200 "unit": "USD",201 "value": "500000.00",202 "remaining_value": "500000.00",203 "implication_of_limit_breach": "BLOCK_CAPABILITY"204 }205 ]206 },207 {208 "name": "RECEIVE_MONEY",209 "limits": [210 {211 "type": "AMOUNT",212 "unit": "USD",213 "value": "500000.00",214 "remaining_value": "500000.00",215 "implication_of_limit_breach": "BLOCK_CAPABILITY"216 }217 ]218 },219 {220 "name": "GOOGLE_PAY",221 "limits": [222 {223 "type": "AMOUNT",224 "unit": "USD",225 "value": "500000.00",226 "remaining_value": "500000.00",227 "implication_of_limit_breach": "BLOCK_CAPABILITY"228 }229 ]230 },231 {232 "name": "WITHDRAW_MONEY",233 "limits": [234 {235 "type": "AMOUNT",236 "unit": "USD",237 "value": "500000.00",238 "remaining_value": "500000.00",239 "implication_of_limit_breach": "BLOCK_CAPABILITY"240 }241 ]242 },243 {244 "name": "CUSTOM_CARD_PROCESSING",245 "limits": [246 {247 "type": "AMOUNT",248 "unit": "USD",249 "value": "500000.00",250 "remaining_value": "500000.00",251 "implication_of_limit_breach": "BLOCK_CAPABILITY"252 }253 ]254 }255 ],256 "required": {257 "op": "ALL_OF",258 "attributes": [259 "$.business_entity.office_bearers[*].citizenship"260 ]261 }262 },263 {264 "name": "MANAGED_PATH_KYC_VERIFICATION",265 "status": "COMPLETED",266 "capabilities": [267 {268 "name": "WITHDRAW_MONEY"269 },270 {271 "name": "GOOGLE_PAY"272 },273 {274 "name": "RECEIVE_MONEY"275 },276 {277 "name": "APPLE_PAY"278 },279 {280 "name": "CUSTOM_CARD_PROCESSING"281 }282 ]283 },284 {285 "name": "MANAGED_PATH_KYC_COLLECTION",286 "status": "COMPLETED",287 "capabilities": [288 {289 "name": "RECEIVE_MONEY"290 },291 {292 "name": "CUSTOM_CARD_PROCESSING"293 },294 {295 "name": "APPLE_PAY"296 },297 {298 "name": "WITHDRAW_MONEY"299 },300 {301 "name": "GOOGLE_PAY"302 }303 ]304 }305 ]306 },307 "links": [308 {309 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/K9K6ERAVXB47C",310 "rel": "self",311 "method": "GET"312 },313 {314 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/K9K6ERAVXB47C",315 "rel": "edit",316 "method": "PATCH"317 }318 ]319}
Sample response: Documents required for verification (US)
The following example is a sample response of a merchant account in the US that must provide documents to complete verification.The required_document object shows the documents the merchant must provide.
1{2 "account_id": "VS5LLPA9KC3JJ",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "VS5LLPA9KC3JJ",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "ZASLDNDUSPJUW",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "2211 N First St ",18 "address_line_2": "Unit 2000",19 "admin_area_2": "San Jose",20 "admin_area_1": "CA",21 "postal_code": "95134",22 "country_code": "US"23 },24 "phone_numbers": [25 {26 "country_code": "030",27 "national_number": "6151175",28 "id": "Q6K8CUKG5AKCG",29 "type": "MOBILE"30 }31 ],32 "birth_details": {33 "date_of_birth": "1995-08-01"34 },35 "identification_documents": [36 {37 "id": "22V4VGNN6FV8J",38 "identification_number": "****",39 "issuing_country_code": "US",40 "type": "SOCIAL_SECURITY_NUMBER"41 }42 ],43 "emails": [44 {45 "id": "XRVVHPAXETTKU",46 "email": "levin-personal-email@paypal.com"47 }48 ]49 }50 ],51 "business_entity": {52 "type": "CORPORATION",53 "merchant_category_code": "5933",54 "incorporation_details": {},55 "names": [56 {57 "business_name": "DECLINED",58 "id": "NKGTBF6QWGKLU",59 "type": "LEGAL"60 }61 ],62 "emails": [63 {64 "id": "L666EU4QXHPAS",65 "email": "levin-business-email@paypal.com"66 }67 ],68 "website_info": {69 "website_exists": true,70 "website_url": "https://developer.paypal.com/docs/multiparty/"71 },72 "registered_business_address": {73 "address_line_1": "2211 N First St ",74 "address_line_2": "Unit 1300",75 "admin_area_2": "San Jose",76 "admin_area_1": "CA",77 "postal_code": "95134",78 "country_code": "US"79 },80 "phone_numbers": [81 {82 "country_code": "1",83 "national_number": "06151188",84 "id": "A2EY3WUGCE2DW",85 "type": "BUSINESS"86 }87 ],88 "identification_documents": [89 {90 "id": "BW9AMRFZUHMXU",91 "identification_number": "****",92 "issuing_country_code": "US",93 "type": "EMPLOYER_IDENTIFICATION_NUMBER"94 }95 ],96 "beneficial_owners": {97 "individuals": [98 {99 "id": "P9MDPQCP6TUDN",100 "names": [101 {102 "given_name": "Lucas DECLINED",103 "surname": "Li DECLINED",104 "id": "B79ZVE39VHS4J",105 "type": "LEGAL"106 }107 ],108 "citizenship": "US",109 "addresses": [110 {111 "address_line_1": "2211 N First St ",112 "address_line_2": "Unit 2100",113 "admin_area_2": "San Jose",114 "admin_area_1": "CA",115 "postal_code": "95134",116 "country_code": "US",117 "id": "REQTZ5USBDBNL",118 "type": "HOME"119 }120 ],121 "phone_numbers": [122 {123 "country_code": "1",124 "national_number": "06151188",125 "id": "VF3RHVAG63YT8",126 "type": "WORK"127 }128 ],129 "birth_details": {130 "date_of_birth": "1990-01-01"131 },132 "identification_documents": [133 {134 "id": "BDM7J5T3SAV22",135 "identification_number": "****",136 "issuing_country_code": "US",137 "type": "SOCIAL_SECURITY_NUMBER"138 }139 ],140 "emails": [141 {142 "email": "lucas-personal-email@gmail.com"143 }144 ],145 "percentage_of_ownership": "30",146 "controlling_influence": false147 }148 ]149 },150 "office_bearers": [151 {152 "id": "FYQQRRY3GR2FN",153 "names": [154 {155 "given_name": "Alexei DECLINED",156 "surname": "Coreiba DECLINED",157 "id": "8XQN7DMTYSQD6",158 "type": "LEGAL"159 }160 ],161 "citizenship": "US",162 "addresses": [163 {164 "address_line_1": "2211 N First St ",165 "address_line_2": "Unit 2123",166 "admin_area_2": "San Jose",167 "admin_area_1": "CA",168 "postal_code": "95134",169 "country_code": "US",170 "id": "DEBZMB4JCJTJA",171 "type": "HOME"172 }173 ],174 "phone_numbers": [175 {176 "country_code": "1",177 "national_number": "06151188",178 "id": "PE4KEUCDNAPVL",179 "type": "WORK"180 }181 ],182 "birth_details": {183 "date_of_birth": "1990-01-01"184 },185 "identification_documents": [186 {187 "id": "WWLUUDEFNBBEC",188 "identification_number": "****",189 "issuing_country_code": "US",190 "type": "SOCIAL_SECURITY_NUMBER"191 }192 ],193 "emails": [194 {195 "email": "alexei-email@gmail.com"196 }197 ]198 }199 ],200 "declarations": [201 {202 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",203 "value": "YES"204 }205 ]206 },207 "agreements": [208 {209 "type": "TERMS_ACCEPTED",210 "accepted_time": "2024-01-01T00:00:00Z"211 }212 ],213 "balances": [214 {215 "available_balances": [216 {217 "currency_code": "USD",218 "value": "0.00"219 }220 ],221 "available": {222 "currency_code": "USD",223 "value": "0.00"224 },225 "reserved": {226 "currency_code": "USD",227 "value": "0.00"228 }229 }230 ],231 "external_id": "EXT-1707165609",232 "organization": "us_org/net",233 "user_id": "1707165608814",234 "primary_currency_code": "USD",235 "soft_descriptor": "DECLINED",236 "capabilities": [237 {238 "name": "APPLE_PAY",239 "limits": [240 {241 "type": "AMOUNT",242 "unit": "USD",243 "value": "5000.00",244 "remaining_value": "5000.00",245 "implication_of_limit_breach": "BLOCK_CAPABILITY"246 }247 ],248 "grace_periods": [249 {250 "start_time": "2024-02-05T20:40:37.110Z",251 "expiry_time": "2024-03-06T20:40:37.110Z"252 }253 ],254 "status": "ACTIVE"255 },256 {257 "name": "GOOGLE_PAY",258 "limits": [259 {260 "type": "AMOUNT",261 "unit": "USD",262 "value": "5000.00",263 "remaining_value": "5000.00",264 "implication_of_limit_breach": "BLOCK_CAPABILITY"265 }266 ],267 "grace_periods": [268 {269 "start_time": "2024-02-05T20:40:37.110Z",270 "expiry_time": "2024-03-06T20:40:37.110Z"271 }272 ],273 "status": "ACTIVE"274 },275 {276 "name": "CUSTOM_CARD_PROCESSING",277 "limits": [278 {279 "type": "AMOUNT",280 "unit": "USD",281 "value": "5000.00",282 "remaining_value": "5000.00",283 "implication_of_limit_breach": "BLOCK_CAPABILITY"284 }285 ],286 "grace_periods": [287 {288 "start_time": "2024-02-05T20:40:37.110Z",289 "expiry_time": "2024-03-06T20:40:37.110Z"290 }291 ],292 "status": "ACTIVE"293 },294 {295 "name": "RECEIVE_MONEY",296 "limits": [297 {298 "type": "AMOUNT",299 "unit": "USD",300 "value": "5000.00",301 "remaining_value": "5000.00",302 "implication_of_limit_breach": "BLOCK_CAPABILITY"303 }304 ],305 "grace_periods": [306 {307 "start_time": "2024-02-05T20:40:37.110Z",308 "expiry_time": "2024-03-06T20:40:37.110Z"309 }310 ],311 "status": "ACTIVE"312 },313 {314 "name": "WITHDRAW_MONEY",315 "status": "NEED_DATA"316 }317 ],318 "process_view": {319 "processes": [320 {321 "name": "MANAGED_PATH_KYC_VERIFICATION",322 "status": "NEED_MORE_DATA",323 "capabilities": [324 {325 "name": "RECEIVE_MONEY",326 "limits": [327 {328 "type": "AMOUNT",329 "unit": "USD",330 "value": "5000.00",331 "remaining_value": "5000.00",332 "implication_of_limit_breach": "BLOCK_CAPABILITY"333 }334 ],335 "grace_periods": [336 {337 "start_time": "2024-02-05T20:40:37.110Z",338 "expiry_time": "2024-03-06T20:40:37.110Z"339 }340 ]341 },342 {343 "name": "CUSTOM_CARD_PROCESSING",344 "limits": [345 {346 "type": "AMOUNT",347 "unit": "USD",348 "value": "5000.00",349 "remaining_value": "5000.00",350 "implication_of_limit_breach": "BLOCK_CAPABILITY"351 }352 ],353 "grace_periods": [354 {355 "start_time": "2024-02-05T20:40:37.110Z",356 "expiry_time": "2024-03-06T20:40:37.110Z"357 }358 ]359 },360 {361 "name": "WITHDRAW_MONEY"362 },363 {364 "name": "GOOGLE_PAY",365 "limits": [366 {367 "type": "AMOUNT",368 "unit": "USD",369 "value": "5000.00",370 "remaining_value": "5000.00",371 "implication_of_limit_breach": "BLOCK_CAPABILITY"372 }373 ],374 "grace_periods": [375 {376 "start_time": "2024-02-05T20:40:37.110Z",377 "expiry_time": "2024-03-06T20:40:37.110Z"378 }379 ]380 },381 {382 "name": "APPLE_PAY",383 "limits": [384 {385 "type": "AMOUNT",386 "unit": "USD",387 "value": "5000.00",388 "remaining_value": "5000.00",389 "implication_of_limit_breach": "BLOCK_CAPABILITY"390 }391 ],392 "grace_periods": [393 {394 "start_time": "2024-02-05T20:40:37.110Z",395 "expiry_time": "2024-03-06T20:40:37.110Z"396 }397 ]398 }399 ],400 "required": {401 "op": "ALL_OF",402 "attributes": [403 {404 "op": "ONE_OF",405 "attributes": [406 "3559c",407 "cff47",408 "3af36",409 "81743",410 "42d50"411 ]412 },413 {414 "op": "ONE_OF",415 "attributes": [416 "e9366",417 "ec8c1",418 "c3612",419 "640b4"420 ]421 },422 "e1ee7"423 ]424 }425 },426 {427 "name": "MANAGED_PATH_BO_VERIFICATION",428 "status": "NEED_MORE_DATA",429 "capabilities": [430 {431 "name": "APPLE_PAY",432 "limits": [433 {434 "type": "AMOUNT",435 "unit": "USD",436 "value": "500000.00",437 "remaining_value": "500000.00",438 "implication_of_limit_breach": "BLOCK_CAPABILITY"439 }440 ]441 },442 {443 "name": "CUSTOM_CARD_PROCESSING",444 "limits": [445 {446 "type": "AMOUNT",447 "unit": "USD",448 "value": "500000.00",449 "remaining_value": "500000.00",450 "implication_of_limit_breach": "BLOCK_CAPABILITY"451 }452 ]453 },454 {455 "name": "RECEIVE_MONEY",456 "limits": [457 {458 "type": "AMOUNT",459 "unit": "USD",460 "value": "500000.00",461 "remaining_value": "500000.00",462 "implication_of_limit_breach": "BLOCK_CAPABILITY"463 }464 ]465 },466 {467 "name": "GOOGLE_PAY",468 "limits": [469 {470 "type": "AMOUNT",471 "unit": "USD",472 "value": "500000.00",473 "remaining_value": "500000.00",474 "implication_of_limit_breach": "BLOCK_CAPABILITY"475 }476 ]477 },478 {479 "name": "WITHDRAW_MONEY",480 "limits": [481 {482 "type": "AMOUNT",483 "unit": "USD",484 "value": "500000.00",485 "remaining_value": "500000.00",486 "implication_of_limit_breach": "BLOCK_CAPABILITY"487 }488 ]489 }490 ],491 "required": {492 "op": "ALL_OF",493 "attributes": [494 "cb54e",495 "a6185"496 ]497 }498 },499 {500 "name": "MANAGED_PATH_BO_COLLECTION",501 "status": "COMPLETED",502 "capabilities": [503 {504 "name": "CUSTOM_CARD_PROCESSING"505 },506 {507 "name": "RECEIVE_MONEY"508 },509 {510 "name": "APPLE_PAY"511 },512 {513 "name": "WITHDRAW_MONEY"514 },515 {516 "name": "GOOGLE_PAY"517 }518 ]519 },520 {521 "name": "MANAGED_PATH_KYC_COLLECTION",522 "status": "COMPLETED",523 "capabilities": [524 {525 "name": "APPLE_PAY"526 },527 {528 "name": "CUSTOM_CARD_PROCESSING"529 },530 {531 "name": "WITHDRAW_MONEY"532 },533 {534 "name": "GOOGLE_PAY"535 },536 {537 "name": "RECEIVE_MONEY"538 }539 ]540 }541 ],542 "required_documents": [543 {544 "id": "e1ee7",545 "name": "BUSINESS_EXISTENCE",546 "entity": "$.business_entity",547 "links": [548 {549 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",550 "rel": "upload",551 "method": "POST"552 }553 ]554 },555 {556 "id": "42d50",557 "name": "BUSINESS_LICENSE",558 "entity": "$.business_entity",559 "links": [560 {561 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",562 "rel": "upload",563 "method": "POST"564 }565 ]566 },567 {568 "id": "640b4",569 "name": "USIRS_EIN_ALLOCATION_LETTER",570 "entity": "$.business_entity",571 "links": [572 {573 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",574 "rel": "upload",575 "method": "POST"576 }577 ]578 },579 {580 "id": "c3612",581 "name": "BUSINESS_INCOME_TAX_RETURN",582 "entity": "$.business_entity",583 "links": [584 {585 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",586 "rel": "upload",587 "method": "POST"588 }589 ]590 },591 {592 "id": "3559c",593 "name": "TAX_ASSESSMENT_NOTICE",594 "entity": "$.business_entity",595 "links": [596 {597 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",598 "rel": "upload",599 "method": "POST"600 }601 ]602 },603 {604 "id": "cff47",605 "name": "UTILITIES_BILL",606 "entity": "$.business_entity",607 "links": [608 {609 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",610 "rel": "upload",611 "method": "POST"612 }613 ]614 },615 {616 "id": "e9366",617 "name": "USIRS_NAME_CHANGE_LETTER",618 "entity": "$.business_entity",619 "links": [620 {621 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",622 "rel": "upload",623 "method": "POST"624 }625 ]626 },627 {628 "id": "3af36",629 "name": "INSURANCE_STATEMENT",630 "entity": "$.business_entity",631 "links": [632 {633 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",634 "rel": "upload",635 "method": "POST"636 }637 ]638 },639 {640 "id": "ec8c1",641 "name": "BANK_STATEMENT",642 "entity": "$.business_entity",643 "links": [644 {645 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",646 "rel": "upload",647 "method": "POST"648 }649 ]650 },651 {652 "id": "a6185",653 "name": "SOCIAL_SECURITY_NUMBER",654 "entity": "$.business_entity.office_bearers[?(@['id']=='FYQQRRY3GR2FN')]",655 "links": [656 {657 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/54a907dc-66f7-424f-a568-a7aa9ef0af76/upload",658 "rel": "upload",659 "method": "POST"660 }661 ]662 },663 {664 "id": "81743",665 "name": "CC_STATEMENT",666 "entity": "$.business_entity",667 "links": [668 {669 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",670 "rel": "upload",671 "method": "POST"672 }673 ]674 },675 {676 "id": "cb54e",677 "name": "SOCIAL_SECURITY_NUMBER",678 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='P9MDPQCP6TUDN')]",679 "links": [680 {681 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/eca7fa47-6c71-42c7-b044-4abd6ecc2ed4/upload",682 "rel": "upload",683 "method": "POST"684 }685 ]686 }687 ]688 },689 "links": [690 {691 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ",692 "rel": "self",693 "method": "GET"694 },695 {696 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ",697 "rel": "edit",698 "method": "PATCH"699 },700 {701 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ/wallet-domains?page=1",702 "rel": "wallet-domains",703 "method": "GET"704 }705 ]706}
Sample response: Information required for verification (EU)
The following example is a sample response when a merchant account verification in the European Union needs more information. The required object shows the data the merchant must provide to complete the verification.
1{2 "account_id": "23PC3HNADFP2J",3 "legal_country_code": "FR",4 "individual_owners": [5 {6 "id": "23PC3HNADFP2J",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "HAKBCPJRUZEP2",12 "type": "LEGAL"13 }14 ],15 "citizenship": "FR",16 "primary_residence": {17 "address_line_1": "24 rue du Faubourg Saint Honore",18 "address_line_2": "Unit 2000",19 "admin_area_2": "Paris",20 "postal_code": "75008",21 "country_code": "FR"22 },23 "phone_numbers": [24 {25 "country_code": "030",26 "national_number": "6151175",27 "id": "VB4FDVSH3KHGS",28 "type": "MOBILE"29 }30 ],31 "birth_details": {32 "date_of_birth": "1995-08-01"33 },34 "identification_documents": [35 {36 "id": "9BMVHX9HM5H3G",37 "identification_number": "****",38 "issuing_country_code": "FR",39 "type": "PASSPORT"40 }41 ],42 "emails": [43 {44 "id": "C6Z86SFR4Q75J",45 "email": "levin-personal-email@paypal.com"46 }47 ]48 }49 ],50 "business_entity": {51 "type": "CORPORATION",52 "merchant_category_code": "5933",53 "incorporation_details": {54 "incorporation_country_code": "FR",55 "incorporation_date": "1999-01-10"56 },57 "names": [58 {59 "business_name": "FINTECH UNICORN",60 "id": "5JD67U874KZJY",61 "type": "LEGAL"62 }63 ],64 "emails": [65 {66 "id": "U4WENYWD5X7PU",67 "email": "levin-business-email@paypal.com"68 }69 ],70 "website": "https://developer.paypal.com/docs/multiparty/",71 "registered_business_address": {72 "address_line_1": "24 rue du Faubourg Saint Honore",73 "address_line_2": "Unit 2100",74 "admin_area_2": "Paris",75 "postal_code": "75008",76 "country_code": "FR"77 },78 "phone_numbers": [79 {80 "country_code": "1",81 "national_number": "06151188",82 "id": "HQE3JWM26N8UU",83 "type": "BUSINESS"84 }85 ],86 "identification_documents": [87 {88 "id": "42HL7HRQHT2JL",89 "identification_number": "****",90 "issuing_country_code": "FR",91 "type": "BUSINESS_REGISTRATION_NUMBER"92 }93 ],94 "declarations": [95 {96 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",97 "value": "NO"98 }99 ]100 },101 "agreements": [102 {103 "type": "TERMS_ACCEPTED",104 "accepted_time": "2024-01-01T00:00:00Z"105 }106 ],107 "external_id": "EXT-1707167597",108 "organization": "us_org/net",109 "user_id": "1707167597387",110 "primary_currency_code": "EUR",111 "soft_descriptor": "FINTECHUNIC",112 "capabilities": [113 {114 "name": "APPLE_PAY",115 "limits": [116 {117 "type": "AMOUNT",118 "unit": "EUR",119 "value": "1000.00",120 "remaining_value": "1000.00",121 "implication_of_limit_breach": "START_GRACE_PERIOD"122 }123 ],124 "status": "ACTIVE"125 },126 {127 "name": "GOOGLE_PAY",128 "limits": [129 {130 "type": "AMOUNT",131 "unit": "EUR",132 "value": "1000.00",133 "remaining_value": "1000.00",134 "implication_of_limit_breach": "START_GRACE_PERIOD"135 }136 ],137 "status": "ACTIVE"138 },139 {140 "name": "CUSTOM_CARD_PROCESSING",141 "limits": [142 {143 "type": "AMOUNT",144 "unit": "EUR",145 "value": "1000.00",146 "remaining_value": "1000.00",147 "implication_of_limit_breach": "START_GRACE_PERIOD"148 }149 ],150 "status": "ACTIVE"151 },152 {153 "name": "RECEIVE_MONEY",154 "status": "ACTIVE"155 },156 {157 "name": "WITHDRAW_MONEY",158 "limits": [159 {160 "type": "AMOUNT",161 "unit": "EUR",162 "value": "1000.00",163 "remaining_value": "1000.00",164 "implication_of_limit_breach": "BLOCK_CAPABILITY"165 }166 ],167 "status": "ACTIVE"168 }169 ],170 "process_view": {171 "processes": [172 {173 "name": "MANAGED_PATH_CIP_COLLECTION",174 "status": "COMPLETED",175 "capabilities": [176 {177 "name": "RECEIVE_MONEY"178 },179 {180 "name": "WITHDRAW_MONEY"181 },182 {183 "name": "GOOGLE_PAY"184 },185 {186 "name": "APPLE_PAY"187 },188 {189 "name": "CUSTOM_CARD_PROCESSING"190 }191 ]192 },193 {194 "name": "MANAGED_PATH_KYC",195 "status": "NEED_MORE_DATA",196 "capabilities": [197 {198 "name": "WITHDRAW_MONEY",199 "limits": [200 {201 "type": "AMOUNT",202 "unit": "EUR",203 "value": "1000.00",204 "remaining_value": "1000.00",205 "implication_of_limit_breach": "BLOCK_CAPABILITY"206 }207 ]208 },209 {210 "name": "CUSTOM_CARD_PROCESSING",211 "limits": [212 {213 "type": "AMOUNT",214 "unit": "EUR",215 "value": "1000.00",216 "remaining_value": "1000.00",217 "implication_of_limit_breach": "START_GRACE_PERIOD"218 }219 ]220 },221 {222 "name": "GOOGLE_PAY",223 "limits": [224 {225 "type": "AMOUNT",226 "unit": "EUR",227 "value": "1000.00",228 "remaining_value": "1000.00",229 "implication_of_limit_breach": "START_GRACE_PERIOD"230 }231 ]232 },233 {234 "name": "APPLE_PAY",235 "limits": [236 {237 "type": "AMOUNT",238 "unit": "EUR",239 "value": "1000.00",240 "remaining_value": "1000.00",241 "implication_of_limit_breach": "START_GRACE_PERIOD"242 }243 ]244 }245 ],246 "required": {247 "op": "ALL_OF",248 "attributes": [249 {250 "op": "ONE_OF",251 "attributes": [252 {253 "op": "ALL_OF",254 "attributes": [255 "$.business_entity.office_bearers[?(@['role']=='CEO')].citizenship",256 "$.business_entity.office_bearers[?(@['role']=='CEO')].names[?(@['type']=='LEGAL')]",257 "$.business_entity.office_bearers[?(@['role']=='CEO')].birth_details.date_of_birth",258 "$.business_entity.office_bearers[?(@['role']=='CEO')].addresses[?(@['type']=='HOME')]"259 ]260 },261 {262 "op": "ALL_OF",263 "attributes": [264 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].citizenship",265 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].names[?(@['type']=='LEGAL')]",266 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].birth_details.date_of_birth",267 "$.business_entity.office_bearers[?(@['role']=='TREASURER')].addresses[?(@['type']=='HOME')]"268 ]269 },270 {271 "op": "ALL_OF",272 "attributes": [273 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].citizenship",274 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].names[?(@['type']=='LEGAL')]",275 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].birth_details.date_of_birth",276 "$.business_entity.office_bearers[?(@['role']=='CHAIRMAN')].addresses[?(@['type']=='HOME')]"277 ]278 },279 {280 "op": "ALL_OF",281 "attributes": [282 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].citizenship",283 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].names[?(@['type']=='LEGAL')]",284 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].birth_details.date_of_birth",285 "$.business_entity.office_bearers[?(@['role']=='SECRETARY')].addresses[?(@['type']=='HOME')]"286 ]287 },288 {289 "op": "ALL_OF",290 "attributes": [291 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].citizenship",292 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].percentage_of_ownership",293 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].names[?(@['type']=='LEGAL')]",294 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].birth_details.date_of_birth",295 "$.business_entity.beneficial_owners.individuals[?(@['percentage_of_ownership']>=0.0)].addresses[?(@['type']=='HOME')]"296 ]297 },298 {299 "op": "ALL_OF",300 "attributes": [301 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].citizenship",302 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].names[?(@['type']=='LEGAL')]",303 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].birth_details.date_of_birth",304 "$.business_entity.office_bearers[?(@['role']=='TRUSTEE')].addresses[?(@['type']=='HOME')]"305 ]306 }307 ]308 },309 "$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].citizenship",310 "$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].names[?(@['type']=='LEGAL')]",311 "$.business_entity.office_bearers[?(@['role']=='DIRECTOR')].birth_details.date_of_birth"312 ]313 }314 }315 ]316 },317 "links": [318 {319 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/23PC3HNADFP2J",320 "rel": "self",321 "method": "GET"322 },323 {324 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/23PC3HNADFP2J",325 "rel": "edit",326 "method": "PATCH"327 }328 ]329}
Sample response: Information needs correction (EU)
If the verification process finds any incorrect information, the process_view object includes required_corrections that list the fields needing correction. This status also indicates that at least one attempt at electronic verification has failed, and the merchant must attempt electronic verification at least one more time.
1{2 "account_id": "USZJERXL88TDL",3 "legal_country_code": "FR",4 "individual_owners": [5 {6 "id": "USZJERXL88TDL",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "5YQX3KBKL7T4S",12 "type": "LEGAL"13 }14 ],15 "citizenship": "FR",16 "primary_residence": {17 "address_line_1": "24 rue du Faubourg Saint Honore",18 "address_line_2": "Unit 2000",19 "admin_area_2": "Paris",20 "postal_code": "75008",21 "country_code": "FR"22 },23 "phone_numbers": [24 {25 "country_code": "030",26 "national_number": "6151175",27 "id": "WNBMJ2MH49GV8",28 "type": "MOBILE"29 }30 ],31 "birth_details": {32 "date_of_birth": "1995-08-01"33 },34 "identification_documents": [35 {36 "id": "XVZWDF8XJ4E56",37 "identification_number": "****",38 "issuing_country_code": "FR",39 "type": "PASSPORT"40 }41 ],42 "emails": [43 {44 "id": "ZGQNPZAHLT2M2",45 "email": "levin-personal-email@paypal.com"46 }47 ]48 }49 ],50 "business_entity": {51 "type": "CORPORATION",52 "merchant_category_code": "5933",53 "incorporation_details": {54 "incorporation_country_code": "FR",55 "incorporation_date": "1999-01-10"56 },57 "names": [58 {59 "business_name": "Fintech Unicorn",60 "id": "JYP26SH5ZMRS2",61 "type": "LEGAL"62 }63 ],64 "emails": [65 {66 "id": "EMHQK8MS2E5HL",67 "email": "levin-business-email@paypal.com"68 }69 ],70 "website": "https://developer.paypal.com/docs/multiparty/",71 "registered_business_address": {72 "address_line_1": "24 rue du Faubourg Saint Honore",73 "address_line_2": "Unit 2100",74 "admin_area_2": "Paris",75 "postal_code": "75008",76 "country_code": "FR"77 },78 "phone_numbers": [79 {80 "country_code": "1",81 "national_number": "06151188",82 "id": "PGYBZUPJAD6D2",83 "type": "BUSINESS"84 }85 ],86 "identification_documents": [87 {88 "id": "QHQ8W2T3DN4V2",89 "identification_number": "****",90 "issuing_country_code": "FR",91 "type": "BUSINESS_REGISTRATION_NUMBER"92 }93 ],94 "beneficial_owners": {95 "individuals": [96 {97 "id": "UJGR6DTJH5QDS",98 "names": [99 {100 "given_name": "Lucas",101 "surname": "Li",102 "id": "JP8BTRPBFJJSY",103 "type": "LEGAL"104 }105 ],106 "citizenship": "FR",107 "addresses": [108 {109 "address_line_1": "24 rue du Faubourg Saint Honore",110 "address_line_2": "Unit 2200",111 "admin_area_2": "Paris",112 "postal_code": "75008",113 "country_code": "FR",114 "id": "XHNHA4FR9EXZL",115 "type": "HOME"116 }117 ],118 "phone_numbers": [119 {120 "country_code": "1",121 "national_number": "06151188",122 "id": "DX29KCM3BQ88C",123 "type": "WORK"124 }125 ],126 "birth_details": {127 "date_of_birth": "1990-01-01"128 },129 "identification_documents": [130 {131 "id": "U2TQ26HZQCDQG",132 "identification_number": "****",133 "issuing_country_code": "FR",134 "type": "NATIONAL_ID_CARD"135 }136 ],137 "emails": [138 {139 "email": "lucas-personal-email@gmail.com"140 }141 ],142 "percentage_of_ownership": "30",143 "controlling_influence": false144 }145 ]146 },147 "office_bearers": [148 {149 "id": "FDT34KT4KHJQG",150 "names": [151 {152 "given_name": "Alexei",153 "surname": "Coreiba",154 "id": "TE9Z2AG96NSY6",155 "type": "LEGAL"156 }157 ],158 "citizenship": "FR",159 "addresses": [160 {161 "address_line_1": "24 rue du Faubourg Saint Honore",162 "address_line_2": "Unit 2300",163 "admin_area_2": "Paris",164 "postal_code": "75008",165 "country_code": "FR",166 "id": "VXL3PNNNS8566",167 "type": "HOME"168 }169 ],170 "phone_numbers": [171 {172 "country_code": "1",173 "national_number": "06151188",174 "id": "FVYF6MMJC2J58",175 "type": "WORK"176 }177 ],178 "birth_details": {179 "date_of_birth": "1990-01-01"180 },181 "identification_documents": [182 {183 "id": "WL5V3MZ53KPDE",184 "identification_number": "****",185 "issuing_country_code": "FR",186 "type": "PASSPORT"187 }188 ],189 "emails": [190 {191 "email": "alexei-email@gmail.com"192 }193 ],194 "role": "DIRECTOR"195 }196 ],197 "declarations": [198 {199 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",200 "value": "YES"201 }202 ]203 },204 "agreements": [205 {206 "type": "TERMS_ACCEPTED",207 "accepted_time": "2024-01-01T00:00:00Z"208 }209 ],210 "balances": [211 {212 "available_balances": [213 {214 "currency_code": "EUR",215 "value": "0.00"216 }217 ],218 "available": {219 "currency_code": "EUR",220 "value": "0.00"221 },222 "reserved": {223 "currency_code": "EUR",224 "value": "0.00"225 }226 }227 ],228 "external_id": "EXT-1707163925",229 "organization": "us_org/net",230 "user_id": "1707163924527",231 "primary_currency_code": "EUR",232 "soft_descriptor": "FINTECHUNICORN",233 "capabilities": [234 {235 "name": "APPLE_PAY",236 "limits": [237 {238 "type": "AMOUNT",239 "unit": "EUR",240 "value": "1000.00",241 "remaining_value": "1000.00",242 "implication_of_limit_breach": "START_GRACE_PERIOD"243 }244 ],245 "status": "ACTIVE"246 },247 {248 "name": "GOOGLE_PAY",249 "limits": [250 {251 "type": "AMOUNT",252 "unit": "EUR",253 "value": "1000.00",254 "remaining_value": "1000.00",255 "implication_of_limit_breach": "START_GRACE_PERIOD"256 }257 ],258 "status": "ACTIVE"259 },260 {261 "name": "CUSTOM_CARD_PROCESSING",262 "limits": [263 {264 "type": "AMOUNT",265 "unit": "EUR",266 "value": "1000.00",267 "remaining_value": "1000.00",268 "implication_of_limit_breach": "START_GRACE_PERIOD"269 }270 ],271 "status": "ACTIVE"272 },273 {274 "name": "RECEIVE_MONEY",275 "status": "ACTIVE"276 },277 {278 "name": "WITHDRAW_MONEY",279 "limits": [280 {281 "type": "AMOUNT",282 "unit": "EUR",283 "value": "1000.00",284 "remaining_value": "1000.00",285 "implication_of_limit_breach": "BLOCK_CAPABILITY"286 }287 ],288 "status": "ACTIVE"289 }290 ],291 "process_view": {292 "processes": [293 {294 "name": "MANAGED_PATH_KYC",295 "status": "NEED_MORE_DATA",296 "capabilities": [297 {298 "name": "GOOGLE_PAY",299 "limits": [300 {301 "type": "AMOUNT",302 "unit": "EUR",303 "value": "1000.00",304 "remaining_value": "1000.00",305 "implication_of_limit_breach": "START_GRACE_PERIOD"306 }307 ]308 },309 {310 "name": "CUSTOM_CARD_PROCESSING",311 "limits": [312 {313 "type": "AMOUNT",314 "unit": "EUR",315 "value": "1000.00",316 "remaining_value": "1000.00",317 "implication_of_limit_breach": "START_GRACE_PERIOD"318 }319 ]320 },321 {322 "name": "APPLE_PAY",323 "limits": [324 {325 "type": "AMOUNT",326 "unit": "EUR",327 "value": "1000.00",328 "remaining_value": "1000.00",329 "implication_of_limit_breach": "START_GRACE_PERIOD"330 }331 ]332 },333 {334 "name": "WITHDRAW_MONEY",335 "limits": [336 {337 "type": "AMOUNT",338 "unit": "EUR",339 "value": "1000.00",340 "remaining_value": "1000.00",341 "implication_of_limit_breach": "BLOCK_CAPABILITY"342 }343 ]344 }345 ],346 "required_corrections": {347 "op": "ALL_OF",348 "attributes": [349 "$.business_entity.type",350 "$.business_entity.identification_documents[?(@['type']=='BUSINESS_REGISTRATION_NUMBER')]",351 "$.business_entity.registered_business_address",352 "$.business_entity.names[?(@['type']=='LEGAL')]"353 ]354 }355 },356 {357 "name": "MANAGED_PATH_CIP_COLLECTION",358 "status": "COMPLETED",359 "capabilities": [360 {361 "name": "APPLE_PAY"362 },363 {364 "name": "RECEIVE_MONEY"365 },366 {367 "name": "GOOGLE_PAY"368 },369 {370 "name": "CUSTOM_CARD_PROCESSING"371 },372 {373 "name": "WITHDRAW_MONEY"374 }375 ]376 }377 ]378 },379 "links": [380 {381 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/USZJERXL88TDL",382 "rel": "self",383 "method": "GET"384 },385 {386 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/USZJERXL88TDL",387 "rel": "edit",388 "method": "PATCH"389 },390 {391 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/USZJERXL88TDL/wallet-domains?page=1",392 "rel": "wallet-domains",393 "method": "GET"394 }395 ]396}
Sample response: Documents required for verification (EU)
The following example is a sample response of a merchant account in the EU that must provide documents to complete verification.The required_document object shows the documents the merchant must provide.
1{2 "account_id": "7WXK6WF4DNRNL",3 "legal_country_code": "FR",4 "individual_owners": [5 {6 "id": "7WXK6WF4DNRNL",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "PVR7JFU79TX32",12 "type": "LEGAL"13 }14 ],15 "citizenship": "FR",16 "primary_residence": {17 "address_line_1": "24 rue du Faubourg Saint Honore",18 "address_line_2": "Unit 2000",19 "admin_area_2": "Paris",20 "postal_code": "75008",21 "country_code": "FR"22 },23 "phone_numbers": [24 {25 "country_code": "030",26 "national_number": "6151175",27 "id": "PJ7YTK9M6VPUA",28 "type": "MOBILE"29 }30 ],31 "birth_details": {32 "date_of_birth": "1995-08-01"33 },34 "identification_documents": [35 {36 "id": "APYHBDZ7EYNWS",37 "identification_number": "****",38 "issuing_country_code": "FR",39 "type": "PASSPORT"40 }41 ],42 "emails": [43 {44 "id": "JQ9YXZCW8X8TY",45 "email": "levin-personal-email@paypal.com"46 }47 ]48 }49 ],50 "business_entity": {51 "type": "CORPORATION",52 "merchant_category_code": "5933",53 "incorporation_details": {54 "incorporation_country_code": "FR",55 "incorporation_date": "1999-01-10"56 },57 "names": [58 {59 "business_name": "Fintech Unicorn",60 "id": "D6JJSUB939N6Q",61 "type": "LEGAL"62 }63 ],64 "emails": [65 {66 "id": "M7NGL85UT44FU",67 "email": "levin-business-email@paypal.com"68 }69 ],70 "website": "https://developer.paypal.com/docs/multiparty/",71 "registered_business_address": {72 "address_line_1": "24 rue du Faubourg Saint Honore",73 "address_line_2": "Unit 2100",74 "admin_area_2": "Paris",75 "postal_code": "75008",76 "country_code": "FR"77 },78 "phone_numbers": [79 {80 "country_code": "1",81 "national_number": "06151188",82 "id": "F29KVBFZURDJ4",83 "type": "BUSINESS"84 }85 ],86 "identification_documents": [87 {88 "id": "4BQ7MT7TTGGRA",89 "identification_number": "****",90 "issuing_country_code": "FR",91 "type": "BUSINESS_REGISTRATION_NUMBER"92 }93 ],94 "beneficial_owners": {95 "individuals": [96 {97 "id": "RT7ZHJNF57SAY",98 "names": [99 {100 "given_name": "Lucas",101 "surname": "Li",102 "id": "4GXU9SQJ48ZZY",103 "type": "LEGAL"104 }105 ],106 "citizenship": "FR",107 "addresses": [108 {109 "address_line_1": "24 rue du Faubourg Saint Honore",110 "address_line_2": "Unit 2200",111 "admin_area_2": "Paris",112 "postal_code": "75008",113 "country_code": "FR",114 "id": "W6SMBMJ4RU456",115 "type": "HOME"116 }117 ],118 "phone_numbers": [119 {120 "country_code": "1",121 "national_number": "06151188",122 "id": "JUH9F7HCFYRB4",123 "type": "WORK"124 }125 ],126 "birth_details": {127 "date_of_birth": "1990-01-01"128 },129 "identification_documents": [130 {131 "id": "6J2S8GKA7MGBQ",132 "identification_number": "****",133 "issuing_country_code": "FR",134 "type": "NATIONAL_ID_CARD"135 }136 ],137 "emails": [138 {139 "email": "lucas-personal-email@gmail.com"140 }141 ],142 "percentage_of_ownership": "30",143 "controlling_influence": false144 }145 ]146 },147 "office_bearers": [148 {149 "id": "LFEYBEJU6YSGQ",150 "names": [151 {152 "given_name": "Alexei",153 "surname": "Coreiba",154 "id": "SWEV79M85SNDY",155 "type": "LEGAL"156 }157 ],158 "citizenship": "FR",159 "addresses": [160 {161 "address_line_1": "24 rue du Faubourg Saint Honore",162 "address_line_2": "Unit 2300",163 "admin_area_2": "Paris",164 "postal_code": "75008",165 "country_code": "FR",166 "id": "PN33HA8Z8WGQN",167 "type": "HOME"168 }169 ],170 "phone_numbers": [171 {172 "country_code": "1",173 "national_number": "06151188",174 "id": "NJXT9VBANW8CJ",175 "type": "WORK"176 }177 ],178 "birth_details": {179 "date_of_birth": "1990-01-01"180 },181 "identification_documents": [182 {183 "id": "YNKN2979NELN2",184 "identification_number": "****",185 "issuing_country_code": "FR",186 "type": "PASSPORT"187 }188 ],189 "emails": [190 {191 "email": "alexei-email@gmail.com"192 }193 ],194 "role": "DIRECTOR"195 }196 ],197 "declarations": [198 {199 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",200 "value": "YES"201 }202 ]203 },204 "agreements": [205 {206 "type": "TERMS_ACCEPTED",207 "accepted_time": "2024-01-01T00:00:00Z"208 }209 ],210 "balances": [211 {212 "available_balances": [213 {214 "currency_code": "EUR",215 "value": "0.00"216 }217 ],218 "available": {219 "currency_code": "EUR",220 "value": "0.00"221 },222 "reserved": {223 "currency_code": "EUR",224 "value": "0.00"225 }226 }227 ],228 "external_id": "EXT-1707165724",229 "organization": "us_org/net",230 "user_id": "1707165723575",231 "primary_currency_code": "EUR",232 "soft_descriptor": "FINTECHUNICORN",233 "capabilities": [234 {235 "name": "APPLE_PAY",236 "limits": [237 {238 "type": "AMOUNT",239 "unit": "EUR",240 "value": "1000.00",241 "remaining_value": "1000.00",242 "implication_of_limit_breach": "START_GRACE_PERIOD"243 }244 ],245 "status": "ACTIVE"246 },247 {248 "name": "GOOGLE_PAY",249 "limits": [250 {251 "type": "AMOUNT",252 "unit": "EUR",253 "value": "1000.00",254 "remaining_value": "1000.00",255 "implication_of_limit_breach": "START_GRACE_PERIOD"256 }257 ],258 "status": "ACTIVE"259 },260 {261 "name": "CUSTOM_CARD_PROCESSING",262 "limits": [263 {264 "type": "AMOUNT",265 "unit": "EUR",266 "value": "1000.00",267 "remaining_value": "1000.00",268 "implication_of_limit_breach": "START_GRACE_PERIOD"269 }270 ],271 "status": "ACTIVE"272 },273 {274 "name": "RECEIVE_MONEY",275 "status": "ACTIVE"276 },277 {278 "name": "WITHDRAW_MONEY",279 "limits": [280 {281 "type": "AMOUNT",282 "unit": "EUR",283 "value": "1000.00",284 "remaining_value": "1000.00",285 "implication_of_limit_breach": "BLOCK_CAPABILITY"286 }287 ],288 "status": "ACTIVE"289 }290 ],291 "process_view": {292 "processes": [293 {294 "name": "MANAGED_PATH_CIP_COLLECTION",295 "status": "COMPLETED",296 "capabilities": [297 {298 "name": "RECEIVE_MONEY"299 },300 {301 "name": "APPLE_PAY"302 },303 {304 "name": "CUSTOM_CARD_PROCESSING"305 },306 {307 "name": "WITHDRAW_MONEY"308 },309 {310 "name": "GOOGLE_PAY"311 }312 ]313 },314 {315 "name": "MANAGED_PATH_KYC",316 "status": "NEED_MORE_DATA",317 "capabilities": [318 {319 "name": "GOOGLE_PAY",320 "limits": [321 {322 "type": "AMOUNT",323 "unit": "EUR",324 "value": "1000.00",325 "remaining_value": "1000.00",326 "implication_of_limit_breach": "START_GRACE_PERIOD"327 }328 ]329 },330 {331 "name": "CUSTOM_CARD_PROCESSING",332 "limits": [333 {334 "type": "AMOUNT",335 "unit": "EUR",336 "value": "1000.00",337 "remaining_value": "1000.00",338 "implication_of_limit_breach": "START_GRACE_PERIOD"339 }340 ]341 },342 {343 "name": "WITHDRAW_MONEY",344 "limits": [345 {346 "type": "AMOUNT",347 "unit": "EUR",348 "value": "1000.00",349 "remaining_value": "1000.00",350 "implication_of_limit_breach": "BLOCK_CAPABILITY"351 }352 ]353 },354 {355 "name": "APPLE_PAY",356 "limits": [357 {358 "type": "AMOUNT",359 "unit": "EUR",360 "value": "1000.00",361 "remaining_value": "1000.00",362 "implication_of_limit_breach": "START_GRACE_PERIOD"363 }364 ]365 }366 ],367 "required": {368 "op": "ALL_OF",369 "attributes": [370 "0c3a6",371 {372 "op": "ONE_OF",373 "attributes": [374 "b9293",375 "2dfa6",376 "88d7d",377 "9ffb6"378 ]379 }380 ]381 },382 "required_corrections": {383 "op": "ALL_OF",384 "attributes": [385 {386 "op": "ONE_OF",387 "attributes": [388 "b9293",389 "2dfa6",390 "88d7d",391 "9ffb6"392 ]393 },394 "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')].citizenship",395 "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')].names[?(@['type']=='LEGAL')]",396 "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')].birth_details.date_of_birth",397 "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')].addresses[?(@['type']=='HOME')]",398 "$.business_entity.type",399 "$.business_entity.identification_documents[?(@['type']=='BUSINESS_REGISTRATION_NUMBER')]",400 "$.business_entity.registered_business_address",401 "0c3a6",402 "$.business_entity.names[?(@['type']=='LEGAL')]"403 ]404 }405 }406 ],407 "required_documents": [408 {409 "id": "88d7d",410 "name": "PROOF_OF_IDENTITY",411 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')]",412 "links": [413 {414 "href": "https://msmaster2intdev51.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/37d7258d-a4fe-41e5-a145-c8ba93dcb481/upload",415 "rel": "upload",416 "method": "POST"417 }418 ]419 },420 {421 "id": "b9293",422 "name": "PASSPORT",423 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')]",424 "links": [425 {426 "href": "https://msmaster2intdev51.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/37d7258d-a4fe-41e5-a145-c8ba93dcb481/upload",427 "rel": "upload",428 "method": "POST"429 }430 ]431 },432 {433 "id": "9ffb6",434 "name": "NATIONAL_ID_CARD",435 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')]",436 "links": [437 {438 "href": "https://msmaster2intdev51.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/37d7258d-a4fe-41e5-a145-c8ba93dcb481/upload",439 "rel": "upload",440 "method": "POST"441 }442 ]443 },444 {445 "id": "2dfa6",446 "name": "DRIVERS_LICENSE",447 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='RT7ZHJNF57SAY')]",448 "links": [449 {450 "href": "https://msmaster2intdev51.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/37d7258d-a4fe-41e5-a145-c8ba93dcb481/upload",451 "rel": "upload",452 "method": "POST"453 }454 ]455 },456 {457 "id": "0c3a6",458 "name": "BUSINESS_REGISTRATION",459 "entity": "$.business_entity",460 "links": [461 {462 "href": "https://msmaster2intdev51.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/41d08d5d-5803-4d38-8934-d7fb866046f4/upload",463 "rel": "upload",464 "method": "POST"465 }466 ]467 }468 ]469 },470 "links": [471 {472 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/7WXK6WF4DNRNL",473 "rel": "self",474 "method": "GET"475 },476 {477 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/7WXK6WF4DNRNL",478 "rel": "edit",479 "method": "PATCH"480 },481 {482 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/7WXK6WF4DNRNL/wallet-domains?page=1",483 "rel": "wallet-domains",484 "method": "GET"485 }486 ]487}
Sample response: Documents required for verification (Canada)
The following example is a sample response of a merchant account in Canada that has failed electronic verification due to insufficient data. In such cases, the process_view includes required_documents object, containing all the documents that need to be uploaded.
1"required_documents": [2 {3 "id": "f8cc0",4 "name": "SECURITIES_REGISTER",5 "entity": "$.business_entity",6 "links": [7 {8 "href": "https://te-ca-fullstack-e2e.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/04f438ec-68f7-4a36-9380-235918efa41f/upload",9 "rel": "upload",10 "method": "POST"11 }12 ]13},14 {15 "id": "be1cd",16 "name": "CORPORATE_TREE_DOCUMENT",17 "entity": "$.business_entity",18 "links": [19 {20 "href": "https://te-ca-fullstack-e2e.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/04f438ec-68f7-4a36-9380-235918efa41f/upload",21 "rel": "upload",22 "method": "POST"23 }24 ]25},26 {27 "id": "d3763",28 "name": "SHAREHOLDER_AGREEMENT",29 "entity": "$.business_entity",30 "links": [31 {32 "href": "https://te-ca-fullstack-e2e.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/04f438ec-68f7-4a36-9380-235918efa41f/upload",33 "rel": "upload",34 "method": "POST"35 }36 ]37},38 {39 "id": "6635d",40 "name": "PARTNERSHIP_AGREEMENT",41 "entity": "$.business_entity",42 "links": [43 {44 "href": "https://te-ca-fullstack-e2e.dev51.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/04f438ec-68f7-4a36-9380-235918efa41f/upload",45 "rel": "upload",46 "method": "POST"47 }48 ]49}50]
Sample response: Documents required for PBS and LOA verification (Canada)
The following example is a sample response of a merchant account in Canada that needs to provide documents for Proof of Business Structure (PBS) and Letter of Authorization (LOA).
It is mandatory to upload documents for verifying PBS and LOA. The sample response contains document upload requirements for the business entity, which are required if we cannot verify your business entity through electronic verification.
1"required_documents": [2 {3 "id": "f1f7f",4 "name": "SECURITIES_REGISTER",5 "entity": "$.business_entity",6 "links": [7 {8 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",9 "rel": "upload",10 "method": "POST"11 }12 ]13 },14 {15 "id": "d4277",16 "name": "CORPORATE_STATUS_CERTIFICATE",17 "entity": "$.business_entity",18 "links": [19 {20 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",21 "rel": "upload",22 "method": "POST"23 }24 ]25 },26 {27 "id": "3d8c8",28 "name": "SHAREHOLDERS_REGISTER",29 "entity": "$.business_entity",30 "links": [31 {32 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",33 "rel": "upload",34 "method": "POST"35 }36 ]37 },38 {39 "id": "fd0ed",40 "name": "CORPORATE_TREE_DOCUMENT",41 "entity": "$.business_entity",42 "links": [43 {44 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",45 "rel": "upload",46 "method": "POST"47 }48 ]49 },50 {51 "id": "87a9f",52 "name": "CERTIFICATE_OF_INCORPORATION",53 "entity": "$.business_entity",54 "links": [55 {56 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",57 "rel": "upload",58 "method": "POST"59 }60 ]61 },62 {63 "id": "c80e8",64 "name": "ANNUAL_BUSINESS_RECORD",65 "entity": "$.business_entity",66 "links": [67 {68 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",69 "rel": "upload",70 "method": "POST"71 }72 ]73 },74 {75 "id": "ad6b8",76 "name": "LETTER_OF_AUTHORIZATION",77 "entity": "$.individual_owners[?(@['id']=='YGUZQM99MZALQ')]",78 "links": [79 {80 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/b71d9e1f-99e2-448f-899f-f7cea0b2f3ac/upload",81 "rel": "upload",82 "method": "POST"83 }84 ]85 },86 {87 "id": "e5003",88 "name": "SHAREHOLDER_AGREEMENT",89 "entity": "$.business_entity",90 "links": [91 {92 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",93 "rel": "upload",94 "method": "POST"95 }96 ]97 },98 {99 "id": "d5443",100 "name": "PARTNERSHIP_AGREEMENT",101 "entity": "$.business_entity",102 "links": [103 {104 "href": "https://te-kyc-verification.dev52.cbf.dev.paypalinc.com:17707/v1/customer/supporting-documents/d1804944-fea7-4512-b7b1-f4937abc4765/upload",105 "rel": "upload",106 "method": "POST"107 }108 ]109 }110 ]
- PayPal requires Proof of Business Structure document to be uploaded and verified.
- PayPal also asks for the Letter of Authorization document to be uploaded and verified, if the Primary Authorized User of the account is NOT the Beneficial Owner or Authorized Representative of the account.
Electronic verification attempts by country
The number of data validation attempts for each non-loginable merchant account varies by country.
|
Country |
Number of attempts |
|
US |
1 |
|
FR |
2 |
|
EU |
2 |
|
CA |
1 |
|
AU |
2 |
|
UK |
2 |
In the US and Canada, you can attempt electronic verification only once, during account creation. However, in France, in you can try electronic verification a second time after creating the account. If you don't want to retry electronic verification and want to ask merchants for documents immediately, resubmit the same data set.
If all the e-verification attempts fail, PayPal will require documents to verify the merchants manually. The list of required documents, including document upload links, can be found in process_view under the required_documents section. Some countries, such as Canada, require mandatory document review and verification for legal entities. You need to upload the document to move forward with the verification process.
Sample responses - Failed document verifications
The following examples show failed verification for US and EU merchant accounts that require document submission.
The US merchant account example shows a response with MANAGED_PATH_BO_VERIFICATION_FAILURE for a $500,000 limit, while the EU merchant account example shows a second e-KYC attempt with a $1,000 limit response.
- US - verification failure
- EU - verification failure
1{2 "account_id": "VS5LLPA9KC3JJ",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "VS5LLPA9KC3JJ",7 "names": [8 {9 "given_name": "Levin",10 "surname": "Huang",11 "id": "ZASLDNDUSPJUW",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "2211 N First St ",18 "address_line_2": "Unit 2000",19 "admin_area_2": "San Jose",20 "admin_area_1": "CA",21 "postal_code": "95134",22 "country_code": "US"23 },24 "phone_numbers": [25 {26 "country_code": "030",27 "national_number": "6151175",28 "id": "Q6K8CUKG5AKCG",29 "type": "MOBILE"30 }31 ],32 "birth_details": {33 "date_of_birth": "1995-08-01"34 },35 "identification_documents": [36 {37 "id": "22V4VGNN6FV8J",38 "identification_number": "****",39 "issuing_country_code": "US",40 "type": "SOCIAL_SECURITY_NUMBER"41 }42 ],43 "emails": [44 {45 "id": "XRVVHPAXETTKU",46 "email": "levin-personal-email@paypal.com"47 }48 ]49 }50 ],51 "business_entity": {52 "type": "CORPORATION",53 "merchant_category_code": "5933",54 "incorporation_details": {},55 "names": [56 {57 "business_name": "DECLINED",58 "id": "NKGTBF6QWGKLU",59 "type": "LEGAL"60 }61 ],62 "emails": [63 {64 "id": "L666EU4QXHPAS",65 "email": "levin-business-email@paypal.com"66 }67 ],68 "website_info": {69 "website_exists": true,70 "website_url": "https://developer.paypal.com/docs/multiparty/"71 },72 "registered_business_address": {73 "address_line_1": "2211 N First St ",74 "address_line_2": "Unit 1300",75 "admin_area_2": "San Jose",76 "admin_area_1": "CA",77 "postal_code": "95134",78 "country_code": "US"79 },80 "phone_numbers": [81 {82 "country_code": "1",83 "national_number": "06151188",84 "id": "A2EY3WUGCE2DW",85 "type": "BUSINESS"86 }87 ],88 "identification_documents": [89 {90 "id": "BW9AMRFZUHMXU",91 "identification_number": "****",92 "issuing_country_code": "US",93 "type": "EMPLOYER_IDENTIFICATION_NUMBER"94 }95 ],96 "beneficial_owners": {97 "individuals": [98 {99 "id": "P9MDPQCP6TUDN",100 "names": [101 {102 "given_name": "Lucas DECLINED",103 "surname": "Li DECLINED",104 "id": "B79ZVE39VHS4J",105 "type": "LEGAL"106 }107 ],108 "citizenship": "US",109 "addresses": [110 {111 "address_line_1": "2211 N First St ",112 "address_line_2": "Unit 2100",113 "admin_area_2": "San Jose",114 "admin_area_1": "CA",115 "postal_code": "95134",116 "country_code": "US",117 "id": "REQTZ5USBDBNL",118 "type": "HOME"119 }120 ],121 "phone_numbers": [122 {123 "country_code": "1",124 "national_number": "06151188",125 "id": "VF3RHVAG63YT8",126 "type": "WORK"127 }128 ],129 "birth_details": {130 "date_of_birth": "1990-01-01"131 },132 "identification_documents": [133 {134 "id": "BDM7J5T3SAV22",135 "identification_number": "****",136 "issuing_country_code": "US",137 "type": "SOCIAL_SECURITY_NUMBER"138 }139 ],140 "emails": [141 {142 "email": "lucas-personal-email@gmail.com"143 }144 ],145 "percentage_of_ownership": "30",146 "controlling_influence": false147 }148 ]149 },150 "office_bearers": [151 {152 "id": "FYQQRRY3GR2FN",153 "names": [154 {155 "given_name": "Alexei DECLINED",156 "surname": "Coreiba DECLINED",157 "id": "8XQN7DMTYSQD6",158 "type": "LEGAL"159 }160 ],161 "citizenship": "US",162 "addresses": [163 {164 "address_line_1": "2211 N First St ",165 "address_line_2": "Unit 2123",166 "admin_area_2": "San Jose",167 "admin_area_1": "CA",168 "postal_code": "95134",169 "country_code": "US",170 "id": "DEBZMB4JCJTJA",171 "type": "HOME"172 }173 ],174 "phone_numbers": [175 {176 "country_code": "1",177 "national_number": "06151188",178 "id": "PE4KEUCDNAPVL",179 "type": "WORK"180 }181 ],182 "birth_details": {183 "date_of_birth": "1990-01-01"184 },185 "identification_documents": [186 {187 "id": "WWLUUDEFNBBEC",188 "identification_number": "****",189 "issuing_country_code": "US",190 "type": "SOCIAL_SECURITY_NUMBER"191 }192 ],193 "emails": [194 {195 "email": "alexei-email@gmail.com"196 }197 ]198 }199 ],200 "declarations": [201 {202 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",203 "value": "YES"204 }205 ]206 },207 "agreements": [208 {209 "type": "TERMS_ACCEPTED",210 "accepted_time": "2024-01-01T00:00:00Z"211 }212 ],213 "balances": [214 {215 "available_balances": [216 {217 "currency_code": "USD",218 "value": "0.00"219 }220 ],221 "available": {222 "currency_code": "USD",223 "value": "0.00"224 },225 "reserved": {226 "currency_code": "USD",227 "value": "0.00"228 }229 }230 ],231 "external_id": "EXT-1707165609",232 "organization": "us_org/net",233 "user_id": "1707165608814",234 "primary_currency_code": "USD",235 "soft_descriptor": "DECLINED",236 "capabilities": [237 {238 "name": "APPLE_PAY",239 "limits": [240 {241 "type": "AMOUNT",242 "unit": "USD",243 "value": "5000.00",244 "remaining_value": "5000.00",245 "implication_of_limit_breach": "BLOCK_CAPABILITY"246 }247 ],248 "grace_periods": [249 {250 "start_time": "2024-02-05T20:40:37.110Z",251 "expiry_time": "2024-03-06T20:40:37.110Z"252 }253 ],254 "status": "ACTIVE"255 },256 {257 "name": "GOOGLE_PAY",258 "limits": [259 {260 "type": "AMOUNT",261 "unit": "USD",262 "value": "5000.00",263 "remaining_value": "5000.00",264 "implication_of_limit_breach": "BLOCK_CAPABILITY"265 }266 ],267 "grace_periods": [268 {269 "start_time": "2024-02-05T20:40:37.110Z",270 "expiry_time": "2024-03-06T20:40:37.110Z"271 }272 ],273 "status": "ACTIVE"274 },275 {276 "name": "CUSTOM_CARD_PROCESSING",277 "limits": [278 {279 "type": "AMOUNT",280 "unit": "USD",281 "value": "5000.00",282 "remaining_value": "5000.00",283 "implication_of_limit_breach": "BLOCK_CAPABILITY"284 }285 ],286 "grace_periods": [287 {288 "start_time": "2024-02-05T20:40:37.110Z",289 "expiry_time": "2024-03-06T20:40:37.110Z"290 }291 ],292 "status": "ACTIVE"293 },294 {295 "name": "RECEIVE_MONEY",296 "limits": [297 {298 "type": "AMOUNT",299 "unit": "USD",300 "value": "5000.00",301 "remaining_value": "5000.00",302 "implication_of_limit_breach": "BLOCK_CAPABILITY"303 }304 ],305 "grace_periods": [306 {307 "start_time": "2024-02-05T20:40:37.110Z",308 "expiry_time": "2024-03-06T20:40:37.110Z"309 }310 ],311 "status": "ACTIVE"312 },313 {314 "name": "WITHDRAW_MONEY",315 "status": "NEED_DATA"316 }317 ],318 "process_view": {319 "processes": [320 {321 "name": "MANAGED_PATH_KYC_VERIFICATION",322 "status": "NEED_MORE_DATA",323 "capabilities": [324 {325 "name": "RECEIVE_MONEY",326 "limits": [327 {328 "type": "AMOUNT",329 "unit": "USD",330 "value": "5000.00",331 "remaining_value": "5000.00",332 "implication_of_limit_breach": "BLOCK_CAPABILITY"333 }334 ],335 "grace_periods": [336 {337 "start_time": "2024-02-05T20:40:37.110Z",338 "expiry_time": "2024-03-06T20:40:37.110Z"339 }340 ]341 },342 {343 "name": "CUSTOM_CARD_PROCESSING",344 "limits": [345 {346 "type": "AMOUNT",347 "unit": "USD",348 "value": "5000.00",349 "remaining_value": "5000.00",350 "implication_of_limit_breach": "BLOCK_CAPABILITY"351 }352 ],353 "grace_periods": [354 {355 "start_time": "2024-02-05T20:40:37.110Z",356 "expiry_time": "2024-03-06T20:40:37.110Z"357 }358 ]359 },360 {361 "name": "WITHDRAW_MONEY"362 },363 {364 "name": "GOOGLE_PAY",365 "limits": [366 {367 "type": "AMOUNT",368 "unit": "USD",369 "value": "5000.00",370 "remaining_value": "5000.00",371 "implication_of_limit_breach": "BLOCK_CAPABILITY"372 }373 ],374 "grace_periods": [375 {376 "start_time": "2024-02-05T20:40:37.110Z",377 "expiry_time": "2024-03-06T20:40:37.110Z"378 }379 ]380 },381 {382 "name": "APPLE_PAY",383 "limits": [384 {385 "type": "AMOUNT",386 "unit": "USD",387 "value": "5000.00",388 "remaining_value": "5000.00",389 "implication_of_limit_breach": "BLOCK_CAPABILITY"390 }391 ],392 "grace_periods": [393 {394 "start_time": "2024-02-05T20:40:37.110Z",395 "expiry_time": "2024-03-06T20:40:37.110Z"396 }397 ]398 }399 ],400 "required": {401 "op": "ALL_OF",402 "attributes": [403 {404 "op": "ONE_OF",405 "attributes": [406 "3559c",407 "cff47",408 "3af36",409 "81743",410 "42d50"411 ]412 },413 {414 "op": "ONE_OF",415 "attributes": [416 "e9366",417 "ec8c1",418 "c3612",419 "640b4"420 ]421 },422 "e1ee7"423 ]424 }425 },426 {427 "name": "MANAGED_PATH_BO_VERIFICATION",428 "status": "NEED_MORE_DATA",429 "capabilities": [430 {431 "name": "APPLE_PAY",432 "limits": [433 {434 "type": "AMOUNT",435 "unit": "USD",436 "value": "500000.00",437 "remaining_value": "500000.00",438 "implication_of_limit_breach": "BLOCK_CAPABILITY"439 }440 ]441 },442 {443 "name": "CUSTOM_CARD_PROCESSING",444 "limits": [445 {446 "type": "AMOUNT",447 "unit": "USD",448 "value": "500000.00",449 "remaining_value": "500000.00",450 "implication_of_limit_breach": "BLOCK_CAPABILITY"451 }452 ]453 },454 {455 "name": "RECEIVE_MONEY",456 "limits": [457 {458 "type": "AMOUNT",459 "unit": "USD",460 "value": "500000.00",461 "remaining_value": "500000.00",462 "implication_of_limit_breach": "BLOCK_CAPABILITY"463 }464 ]465 },466 {467 "name": "GOOGLE_PAY",468 "limits": [469 {470 "type": "AMOUNT",471 "unit": "USD",472 "value": "500000.00",473 "remaining_value": "500000.00",474 "implication_of_limit_breach": "BLOCK_CAPABILITY"475 }476 ]477 },478 {479 "name": "WITHDRAW_MONEY",480 "limits": [481 {482 "type": "AMOUNT",483 "unit": "USD",484 "value": "500000.00",485 "remaining_value": "500000.00",486 "implication_of_limit_breach": "BLOCK_CAPABILITY"487 }488 ]489 }490 ],491 "required": {492 "op": "ALL_OF",493 "attributes": [494 "cb54e",495 "a6185"496 ]497 }498 },499 {500 "name": "MANAGED_PATH_BO_COLLECTION",501 "status": "COMPLETED",502 "capabilities": [503 {504 "name": "CUSTOM_CARD_PROCESSING"505 },506 {507 "name": "RECEIVE_MONEY"508 },509 {510 "name": "APPLE_PAY"511 },512 {513 "name": "WITHDRAW_MONEY"514 },515 {516 "name": "GOOGLE_PAY"517 }518 ]519 },520 {521 "name": "MANAGED_PATH_KYC_COLLECTION",522 "status": "COMPLETED",523 "capabilities": [524 {525 "name": "APPLE_PAY"526 },527 {528 "name": "CUSTOM_CARD_PROCESSING"529 },530 {531 "name": "WITHDRAW_MONEY"532 },533 {534 "name": "GOOGLE_PAY"535 },536 {537 "name": "RECEIVE_MONEY"538 }539 ]540 }541 ],542 "required_documents": [543 {544 "id": "e1ee7",545 "name": "BUSINESS_EXISTENCE",546 "entity": "$.business_entity",547 "links": [548 {549 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",550 "rel": "upload",551 "method": "POST"552 }553 ]554 },555 {556 "id": "42d50",557 "name": "BUSINESS_LICENSE",558 "entity": "$.business_entity",559 "links": [560 {561 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",562 "rel": "upload",563 "method": "POST"564 }565 ]566 },567 {568 "id": "640b4",569 "name": "USIRS_EIN_ALLOCATION_LETTER",570 "entity": "$.business_entity",571 "links": [572 {573 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",574 "rel": "upload",575 "method": "POST"576 }577 ]578 },579 {580 "id": "c3612",581 "name": "BUSINESS_INCOME_TAX_RETURN",582 "entity": "$.business_entity",583 "links": [584 {585 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",586 "rel": "upload",587 "method": "POST"588 }589 ]590 },591 {592 "id": "3559c",593 "name": "TAX_ASSESSMENT_NOTICE",594 "entity": "$.business_entity",595 "links": [596 {597 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",598 "rel": "upload",599 "method": "POST"600 }601 ]602 },603 {604 "id": "cff47",605 "name": "UTILITIES_BILL",606 "entity": "$.business_entity",607 "links": [608 {609 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",610 "rel": "upload",611 "method": "POST"612 }613 ]614 },615 {616 "id": "e9366",617 "name": "USIRS_NAME_CHANGE_LETTER",618 "entity": "$.business_entity",619 "links": [620 {621 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",622 "rel": "upload",623 "method": "POST"624 }625 ]626 },627 {628 "id": "3af36",629 "name": "INSURANCE_STATEMENT",630 "entity": "$.business_entity",631 "links": [632 {633 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",634 "rel": "upload",635 "method": "POST"636 }637 ]638 },639 {640 "id": "ec8c1",641 "name": "BANK_STATEMENT",642 "entity": "$.business_entity",643 "links": [644 {645 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",646 "rel": "upload",647 "method": "POST"648 }649 ]650 },651 {652 "id": "a6185",653 "name": "SOCIAL_SECURITY_NUMBER",654 "entity": "$.business_entity.office_bearers[?(@['id']=='FYQQRRY3GR2FN')]",655 "links": [656 {657 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/54a907dc-66f7-424f-a568-a7aa9ef0af76/upload",658 "rel": "upload",659 "method": "POST"660 }661 ]662 },663 {664 "id": "81743",665 "name": "CC_STATEMENT",666 "entity": "$.business_entity",667 "links": [668 {669 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/877a54da-823e-4a7a-a92b-aa49bd7644ef/upload",670 "rel": "upload",671 "method": "POST"672 }673 ]674 },675 {676 "id": "cb54e",677 "name": "SOCIAL_SECURITY_NUMBER",678 "entity": "$.business_entity.beneficial_owners.individuals[?(@['id']=='P9MDPQCP6TUDN')]",679 "links": [680 {681 "href": "https://msmaster2int.g.devqa.gcp.dev.paypalinc.com:17707/v1/customer/supporting-documents/eca7fa47-6c71-42c7-b044-4abd6ecc2ed4/upload",682 "rel": "upload",683 "method": "POST"684 }685 ]686 }687 ]688 },689 "links": [690 {691 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ",692 "rel": "self",693 "method": "GET"694 },695 {696 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ",697 "rel": "edit",698 "method": "PATCH"699 },700 {701 "href": "https://msmaster.qa.paypal.com/v3/customer/managed-accounts/VS5LLPA9KC3JJ/wallet-domains?page=1",702 "rel": "wallet-domains",703 "method": "GET"704 }705 ]706}
Required documents
The documents you submit for verification vary by country.
Canada
| Type | Supporting documents |
|
Proof of Business Structure For all legal entities—including corporations, non-profits, and other business types—the merchant must provide the Business Structure upfront as part of the onboarding process. Proof of Business Structure (PBS) applies only to business entities. |
|
|
Letter Of Authorization For all legal entities—including corporations, non-profits, and other legal entities—the merchant must provide |
For more information, see the sample LOA, available for download and reference. |
|
Proof Of Business |
|
|
Proof of Identity |
|
|
Proof of Address |
|
Start manual verification
After gathering the required information from your merchants, use the PATCH /v3/customer/managed-accounts/{id} endpoint or the POST /v1/customer/supporting-documents/{doc-id} endpoint to send the information to PayPal.
Depending on the type of update you need to complete, follow these options:
Use PATCH to add information
Use the PATCH method to add missing data to the merchant account.
The following example shows how to add an SSN to a merchant account in the United States.
1curl --location --request PATCH 'https://<Host>/v3/customer/managed-accounts/<Account-ID>’23{4 "op": "add",5 "path": "/attributes",6 "value": [7 {8 "name": "SELF_CERTIFICATION",9 "value": "true"10 }11 ]12}
The PATCH request payload includes the value array. To certify that you have provided all necessary merchant information for verification, set value.name to SELF-CERTIFICATION and value.value to true. Self-certify your merchant information to ensure the account verification succeeds and the account does not get stuck in an intermediary state.
For more information, see Update merchant accounts.
Use PATCH to correct information
If your merchant has incorrect information that needs to be corrected, use the PATCH method to replace the incorrect data.
The following example shows how to replace the SSN in a US merchant account.
1curl --location --request PATCH 'https://<Host>/v3/customer/managed-accounts/<Account-ID>’2[3{4 "op": "replace",5 "path": "/individual_owners/@id=='{{individual_owner_id}}'/identification_documents/-",6 "value": {7 "type":"SOCIAL_SECURITY_NUMBER",8 "identification_number":"151221234",9 "issuing_country_code":"US"10 }11}12]
Replacement is rarely required for merchants in the US. You only have one electronic verification attempt in the US, so you must provide documents to complete verification. However, your merchant may notice other inaccurate information, which you can update using the PATCH method.
Use POST to send documents
If your merchant needs to provide a document to complete verification, use the Supporting Documents API.
The following example shows how to submit documents for verification in the US and Canada:
- US - Proof of Identity
- Canada - Proof of Business Structure
1curl -v -X \23POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \45-H "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \67-H "Authorization: Bearer Access-Token" \89-F 'input={"document_info": "{"document_type":"DRIVERS_LICENSE"}"};type=application/json' \1011-F 'driver_licence_front_and_back=@driver_licence_front_and_back.jpeg' \
Monitor for webhooks
After you submit all your documentation for your merchant account, PayPal begins the electronic or manual verification, depending on the region.
In both cases, the following webhooks are triggered:
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATE
PayPal sends this webhook notification when the merchant account update occurs.
The following example shows a CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATED webhook for a US merchant account.
1{2 "description": "Account update webhook.",3 "title": "Update Account",4 "runnable": true,5 "operationId": "webhook.account_updated",6 "request": {7 "path": "v1/notifications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R",8 "method": "GET",9 "headers": {10 "Authorization": "Bearer zekwhYgsYYI0zDg0p_Nf5v78VelCfYR0"11 }12 },13 "response": {14 "status": "200 OK",15 "headers": {},16 "body": {17 "id": "WH-3AE50806EM5305732-8C457463XB353952R",18 "event_version": "1.0",19 "update_time": "2018-05-24T07:18:28.264Z",20 "resource_type": "managed-accounts",21 "event_type": "CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATED",22 "summary": "A managed account was updated.",23 "resource": {24 "account_id": "7G4EPEEPEF74L",25 "external_id": "external_id_353535335",26 "links": [27 {28 "rel": "self",29 "href": "https://api-m.paypal.com/v3/customer/managed-accounts/7G4EPEEPEF74L",30 "method": "GET"31 }32 ]33 },34 "application_context": {35 "event_context": "INFO",36 "event_targets": [37 "business_entity.phone_numbers",38 "business_entity.identification_documents"39 ]40 },41 "links": [42 {43 "href": "https://api-m.paypal.com/v1/notfications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R",44 "rel": "self",45 "method": "GET"46 },47 {48 "href": "https://api-m.paypal.com/v1/notfications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R/resend",49 "rel": "resend",50 "method": "POST"51 }52 ]53 }54 }55}
Note: ACCOUNT-UPDATED webhooks contain an actor field to help identify the source of an edit. If a PayPal representative edits the account during verification, the actor is set to PAYPAL. If you edit the account, the actor is set to CLIENT.
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED
PayPal sends this webhook notification when the merchant account verification begins.
The following example shows a CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED webhook for a US merchant account.
1{2 "description": "Account status changed webhook.",3 "title": "Account Status Changed",4 "runnable": true,5 "operationId": "webhook.account_status_changed",6 "request": {7 "path": "v1/notifications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R",8 "method": "GET",9 "headers": {10 "Authorization": "Bearer zekwhYgsYYI0zDg0p_Nf5v78VelCfYR0"11 }12 },13 "response": {14 "status": "200 OK",15 "headers": {},16 "body": {17 "id": "WH-73186841AE655754N-74C4436203650953C",18 "event_version": "1.0",19 "create_time": "2022-01-07T19:23:30.000Z",20 "resource_type": "managed-accounts",21 "event_type": "CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED",22 "summary": "An account status has been changed",23 "resource": {24 "processes": [25 {26 "name": "MANAGED_PATH_BO_VERIFICATION",27 "status": "COMPLETED"28 },29 {30 "name": "MANAGED_PATH_KYC",31 "status": "NEED_MORE_DATA"32 }33 ],34 "document_rejections_reasons": [35 {36 "entity": "$.individual_owners[?(@['id']=='TP9PNVXEVYSG2')]",37 "name": "SOCIAL_SECURITY_NUMBER",38 "rejection_reasons": [39 {40 "rejection_code": "PARTIAL_DOCUMENT_RECEIVED",41 "description": "Front and Back both copies are not provided"42 }43 ]44 }45 ],46 "account_id": "TP9PNVXEVYSG2",47 "capabilities": [48 {49 "name": "RECEIVE_MONEY",50 "status": "ACTIVE"51 },52 {53 "name": "SEND_MONEY",54 "status": "ACTIVE"55 },56 {57 "name": "CUSTOM_CARD_PROCESSING",58 "status": "ACTIVE"59 },60 {61 "name": "WITHDRAW_MONEY",62 "status": "ACTIVE"63 },64 {65 "name": "CUSTOM_BANK_PROCESSING",66 "status": "ACTIVE"67 }68 ],69 "application_context": {70 "event_context": "ACTION"71 },72 "external_id": "EXT-1641583295",73 "links": [74 {75 "rel": "self",76 "href": "https://api.paypal.com/v3/customer/managed-accounts/TP9PNVXEVYSG2",77 "method": "GET"78 },79 {80 "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks-events/WH-73186841AE655754N-74C4436203650953C/resend",81 "rel": "resend",82 "method": "POST"83 }84 ]85 },86 "links": [87 {88 "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks-events/WH-73186841AE655754N-74C4436203650953C",89 "rel": "self",90 "method": "GET"91 }92 ]93 }94 },95 "description": "Account state changes for Capabilities or Processes",96 "title": "Account state change",97 "runnable": true,98 "operationId": "webhook.account_status_changed",99 "request": {100 "path": "v1/notifications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R",101 "method": "GET",102 "headers": {103 "Authorization": "Bearer zekwhYgsYYI0zDg0p_Nf5v78VelCfYR0"104 }105 },106 "response": {107 "status": "200 OK",108 "headers": {},109 "body": {110 "id": "WH-3AE50806EM5305732-8C457463XB353952R",111 "event_version": "1.0",112 "create_time": "2019-01-25T07:18:28.264Z",113 "resource_type": "managed-accounts",114 "event_type": "CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED",115 "summary": "Managed account capability status changed.",116 "resource": {117 "account_id": "7G4EPEEPEF74L",118 "external_id": "external_id_353535335",119 "capabilities": [120 {121 "name": "CUSTOM_CARD_PROCESSING",122 "status": "ACTIVE"123 },124 {125 "name": "GOOGLE_PAY",126 "status": "REVOKED"127 },128 {129 "name": "APPLE_PAY",130 "status": "SUSPENDED"131 },132 {133 "name": "WITHDRAW_MONEY",134 "status": "NEED_DATA"135 },136 {137 "name": "SEND_MONEY",138 "status": "INACTIVE"139 },140 {141 "name": "RECEIVE_MONEY",142 "status": "ACTIVE"143 }144 ],145 "links": [146 {147 "rel": "self",148 "href": "https://api-m.paypal.com/v3/customer/managed-accounts/7G4EPEEPEF74L",149 "method": "GET"150 },151 {152 "rel": "edit",153 "href": "https://api-m.paypal.com/v3/customer/managed-accounts/7G4EPEEPEF74L",154 "method": "PATCH"155 }156 ]157 },158 "application_context": {159 "event_context": "ACTION"160 },161 "links": [162 {163 "href": "https://api-m.paypal.com/v1/notifications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R",164 "rel": "self",165 "method": "GET"166 },167 {168 "href": "https://api-m.paypal.com/v1/notifications/webhooks-events/WH-3AE50806EM5305732-8C457463XB353952R/resend",169 "rel": "resend",170 "method": "POST"171 }172 ]173 }174 }175}
After receiving this webhook, complete a GET request to /v3/customer/managed-accounts/{id} to determine next steps.
Analyze JSON response to verify or request more information
Use the capabilities array to determine if the verification on the merchant account is completed.
If PayPal completes a manual document review, the capabilities array shows the "status": "MANUAL_REVIEW. At this point, you do not need to provide additional information. PayPal's operations teams review all documents within 24 hours and will provide further details. After the review, you receive an ACCOUNT-STATUS-CHANGED response. Make a GET call to determine the next steps.
Sample response for a merchant account under manual review
- US
- CA
1{2 "process_view": {3 "processes": [4 {5 "name": "MANAGED_PATH_KYC_VERIFICATION",6 "status": "MANUAL_REVIEW",7 "capabilities": [8 {9 "name": "RECEIVE_MONEY",10 "limits": [11 {12 "type": "AMOUNT",13 "unit": "USD",14 "value": "5000.00",15 "remaining_value": "5000.00",16 "implication_of_limit_breach": "BLOCK_CAPABILITY"17 }18 ],19 "grace_periods": [20 {21 "start_time": "2024-02-05T20:40:37.110Z",22 "expiry_time": "2024-03-06T20:40:37.110Z"23 }24 ]25 },26 {27 "name": "CUSTOM_CARD_PROCESSING",28 "limits": [29 {30 "type": "AMOUNT",31 "unit": "USD",32 "value": "5000.00",33 "remaining_value": "5000.00",34 "implication_of_limit_breach": "BLOCK_CAPABILITY"35 }36 ],37 "grace_periods": [38 {39 "start_time": "2024-02-05T20:40:37.110Z",40 "expiry_time": "2024-03-06T20:40:37.110Z"41 }42 ]43 },44 {45 "name": "WITHDRAW_MONEY"46 },47 {48 "name": "GOOGLE_PAY",49 "limits": [50 {51 "type": "AMOUNT",52 "unit": "USD",53 "value": "5000.00",54 "remaining_value": "5000.00",55 "implication_of_limit_breach": "BLOCK_CAPABILITY"56 }57 ],58 "grace_periods": [59 {60 "start_time": "2024-02-05T20:40:37.110Z",61 "expiry_time": "2024-03-06T20:40:37.110Z"62 }63 ]64 },65 {66 "name": "APPLE_PAY",67 "limits": [68 {69 "type": "AMOUNT",70 "unit": "USD",71 "value": "5000.00",72 "remaining_value": "5000.00",73 "implication_of_limit_breach": "BLOCK_CAPABILITY"74 }75 ],76 "grace_periods": [77 {78 "start_time": "2024-02-05T20:40:37.110Z",79 "expiry_time": "2024-03-06T20:40:37.110Z"80 }81 ]82 }83 ]84 },85 {86 "name": "MANAGED_PATH_BO_VERIFICATION",87 "status": "MANUAL_REVIEW",88 "capabilities": [89 {90 "name": "APPLE_PAY",91 "limits": [92 {93 "type": "AMOUNT",94 "unit": "USD",95 "value": "500000.00",96 "remaining_value": "500000.00",97 "implication_of_limit_breach": "BLOCK_CAPABILITY"98 }99 ]100 },101 {102 "name": "CUSTOM_CARD_PROCESSING",103 "limits": [104 {105 "type": "AMOUNT",106 "unit": "USD",107 "value": "500000.00",108 "remaining_value": "500000.00",109 "implication_of_limit_breach": "BLOCK_CAPABILITY"110 }111 ]112 },113 {114 "name": "RECEIVE_MONEY",115 "limits": [116 {117 "type": "AMOUNT",118 "unit": "USD",119 "value": "500000.00",120 "remaining_value": "500000.00",121 "implication_of_limit_breach": "BLOCK_CAPABILITY"122 }123 ]124 },125 {126 "name": "GOOGLE_PAY",127 "limits": [128 {129 "type": "AMOUNT",130 "unit": "USD",131 "value": "500000.00",132 "remaining_value": "500000.00",133 "implication_of_limit_breach": "BLOCK_CAPABILITY"134 }135 ]136 },137 {138 "name": "WITHDRAW_MONEY",139 "limits": [140 {141 "type": "AMOUNT",142 "unit": "USD",143 "value": "500000.00",144 "remaining_value": "500000.00",145 "implication_of_limit_breach": "BLOCK_CAPABILITY"146 }147 ]148 }149 ]150 },151 {152 "name": "MANAGED_PATH_BO_COLLECTION",153 "status": "COMPLETED",154 "capabilities": [155 {156 "name": "CUSTOM_CARD_PROCESSING"157 },158 {159 "name": "RECEIVE_MONEY"160 },161 {162 "name": "APPLE_PAY"163 },164 {165 "name": "WITHDRAW_MONEY"166 },167 {168 "name": "GOOGLE_PAY"169 }170 ]171 },172 {173 "name": "MANAGED_PATH_KYC_COLLECTION",174 "status": "COMPLETED",175 "capabilities": [176 {177 "name": "APPLE_PAY"178 },179 {180 "name": "CUSTOM_CARD_PROCESSING"181 },182 {183 "name": "WITHDRAW_MONEY"184 },185 {186 "name": "GOOGLE_PAY"187 },188 {189 "name": "RECEIVE_MONEY"190 }191 ]192 }193 ]194 }195}
- After PayPal completes the electronic or manual verification on the merchant account, all sections under the
capabilitiesarray shows"status": "ACTIVE"and no limitations. - If the merchant needs to provide more information or documents to proceed, the response shows
"status": "ACTIVE"with a"limits"block or"status": "NEED_DATA". - If any
"capabilities"do not have"status: ACTIVE", use theprocess_viewmethod to find all the information you need to communicate to your merchants on how to proceed.
For more information, see Analyze JSON Response.
Sample response: Documentation is rejected
If PayPal reviews and rejects the merchant's document, you'll see a new section in the process_view method called "document_rejections_reasons. This section shows the reasons for the rejection of the documents. You can localize the description of the reason and share it directly with your customers, or you can edit it to match your company's voice.
In the following example, a document is rejected for a US merchant account because the document is too blurry and has missing pages.
1{2 "document_rejections_reasons": [3 {4 "id": "cDY7L",5 "name": "SSN",6 "entity": "$.business_entity.office_bearers[?(@['id'] == 'R2Y2ZQGHCN5BE')]",7 "rejection_reasons": [8 {9 "rejection_code": "PARTIAL_DOCUMENT_RECEIVED",10 "description": "We only received a portion of the SSN document you provided. Please upload a new document that shows the entire page or pages. Please don't cover or mask any of the information shown on the document."11 },12 {13 "rejection_code": "DOCUMENT_RESOLUTION_LOW",14 "description": "The document you provided is illegible, because it’s either too blurry, too bright, too dark, or the resolution is low. Please upload a new document that can be easily read."15 }16 ]17 }18 ]19}
Reasons for document rejection
The following table lists the reasons why PayPal may reject the submitted documentation.
|
Rejection Reasons |
Description |
Geography |
|
POI_EXPIRED |
The proof of identity document you provided has expired. Please upload a current proof of identity document. |
Global |
|
POA_VALIDITY_PASSED_3_MONTHS |
The proof of address document you provided was not issued within the last 3 months. Please upload a new proof of address document with the correct issue date. |
Global |
|
POI_MISSING_ISSUE_ OR_EXPIRY_DATE |
The proof of identity document you provided doesn't include an issue date or expiration date. Please upload a new proof of identity document showing one of these. |
Global |
|
PARTIAL_DOCUMENT_RECEIVED |
We only received a portion of the <Doc_Type> document you provided. Please upload a new document that shows the entire page or pages. Please don't cover or mask any of the information shown on the document. |
Global |
|
POI_ONLY_BIRTH_ |
We received your birth certificate, but also need a supporting document. Please provide a government document (tax authority letter, social welfare letter) or by an authorized financial service entity (bank/card statement) that confirms your name and address. |
EU, MX |
|
POA_DATE_OF_ISSUE_MISSING |
Proof of address document is missing the date it was issued. Please upload a new document showing your current address and the date the document was issued. |
Global |
|
POA_LOGO_OR_FOOTER_MISSING |
The proof of address document you provided is missing a logo or footer. Please upload a new document that includes a logo or footer. |
EU, MX, TH |
|
MISSING_RESIDENTIAL_ADDRESS |
The proof of address document you provided includes a P.O. box instead of a residential address. Unfortunately, we can't accept P.O. boxes. Please upload a new document that includes your residential address. |
Global |
|
SINGLE_DOCUMENT_RECEIVED_ FOR_POI_AND_POA |
You provided one document to prove both your identity and your address. Please upload a separate document for each. |
Global |
|
WRONG_DOCUMENT_RECEIVED |
The document you provided for <Doc_Type> was incorrect. Please log in to your account and follow the instructions in your notification to upload a new document. |
Global |
|
ONE_SIDE_OF_DOCUMENT_RECEIVED |
We only received one page of the <Doc_Type> document you provided. Please upload a new document that shows both pages. |
Global |
|
DOCUMENT_RESOLUTION_LOW |
The document you provided is illegible, because it's either too blurry, too bright, too dark, or the resolution is low . Please upload a new document that can be easily read. |
Global |
|
UNABLE_TO_OPEN_PDF |
We can't open the PDF you provided. Please upload a new document. |
Global |
|
DOCUMENT_FIRSTNAME_ DOES_NOT_MATCH |
The first name shown on document you provided doesn't match the first name shown in your account. Please provide a new document that includes the same first name shown in your account. |
Global |
|
DOCUMENT_SURNAME_ |
The last name shown on document you provided doesn't match the last name shown in your account. Please provide a new document that includes the same last name shown in your account. |
Global |
|
DOCUMENT_COMPLETE_ NAME_DOES_NOT_MATCH |
The first and last name shown on document you provided doesn't match the first and last name on your account. Please provide a new document that includes the same first and last name on your account. |
Global |
|
NON_RESIDENTIAL_ADDRESS_ IN_CUSTOMER_PROFILE |
Please update your account with a residential address. |
Global |
|
POA_ADDRESS_NOT_MATCHING_ ADDRESS_IN_PROFILE |
The address shown on your proof of address document doesn't match the address on your account. Please update either your proof of address document or the address on your account. |
Global |
|
INCOMPLETE_PARTIAL_ADDRESS |
The proof of address document you provided doesn't show a complete address. Please upload a new proof of address document that includes the full address. |
Global |
|
BUSINESS_DOC_LEGAL_ NAME_MISTMATCH |
The business name shown in the business document you provided doesn't match the name shown in your PayPal account. Please update legal business name (as applicable) and upload a new proof of business document with a legal business name that matches the one shown in your PayPal account. |
AU, BR, IN TH, US |
|
NAME_CHANGE_ |
If you have legally changed your name, please provide a copy of the legal document (i.e. marriage certificate, divorce decree) confirming the change. |
Global |
|
CONTACT_NAME_CHANGE |
The name shown in your identity document doesn't match the name used on your account. If you want to change the name in your profile, please upload a letter on company stationery that includes:- The current and new account holder's names- Reason for the name change - The email address, postal address and phone number as registered on your account. |
Global |
|
NONE_GOVT_ISSUED_ID |
The proof of identity document you provided is not a government issued photo ID. Please provide a new document to confirm your identity. |
Global |
|
UNDERAGE_BUSINESS_PAU |
The contact person listed on the document you provided is a minor. The contact person of your account must be the age of majority in your jurisdiction. Please change the contact person on your account and upload a document for the new contact person. |
CA |
|
POA_VIRTUAL_OR_ PO_BOX_ADDRESS |
The document you provided contains a P.O. Box or a virtual address. We require a physical address for verification. Please update your account, if necessary, and upload a new document issued within 12 months that includes a physical business address and company name. |
CA |
|
UPGRADE_NOT_ALLOWED |
Our records indicate that this account was created as an individual account. If you want an account for a legal entity business, please open a new business account. |
CA |
|
DOWNGRADE_CLOSE_ACCOUNT |
Our records indicate that you may have signed up for an account with the wrong business type. Unfortunately, we are unable to change your current account to the correct business type. If you want to change your business type, please sign up for a new account. |
CA |
|
BO_POA |
Please upload a new document as a proof of address for the beneficial owner. |
CA |
|
PROOF_OF_BUSINESS_STRUCTURE |
Please provide a document confirming the organizational structure of your business, including the names of beneficial owners and/or individuals with control rights. We can accept one of the following: •Official supporting documentation (e.g. Corporate tree etc.) •Securities register •Shareholders register •Shareholder Agreement •Partnership Agreement. |
CA |
|
BUSINESS_CROSS_JURISDICTION |
The document you have provided shows your business is registered in a different country. Please provide us a business registration document showing your registration in Canada. |
CA |
|
EU_LOA_MISSING_ELEMENTS |
The letter of authorization you provided is missing some information. Please upload a new document that includes: -The PayPal account holder's full name and position in the company-The business name and business registration number as it appears on your business registration document-The full name, position in the company and signature of a duly authorized person (such as, CEO, CFO, managing director, or chairperson). |
EU |
|
POA_VIRTUAL_ADDRESS |
The proof of address document you provided contains a virtual address. Please upload a new document (e.g., utility bill) that includes a physical business address and company name. |
EU |
|
BUSINESS_DOC_MISSING_ELEMENTS |
The business document your provided is missing some of the required information. Please upload a new business document containing: company name, business registration number and business address. |
EU, MX, TH |
|
FA_DECLARATION_RECEIVED |
We received you Club Declaration Statement, but we also need a bank statement. Please upload a bank statement that includes the name of the club. |
EU |
|
FA_DECLARATION_ |
The Club Declaration Statement you provided is missing a signature. Please provide a new copy of the declaration with a signature and printed name from a Club Chair, Secretary, or Treasurer. You can download the declaration form on the Whole Game System payments portal. |
EU |
|
EU_PARTNERSHIP_AGREEMENT_ MISSING_ELEMENT |
The business document you provided is missing some information about your partnership. Please upload a new business document that includes:-The partnership name-The full names of all partners-Signatures of all partners |
EU |
|
EU_VAT_DECLARATION_ MISSING_ELEMENT |
The VAT Declaration you provided is missing some information. Please upload a new VAT Declaration from your local tax authority that includes:- The partnership name- Full names of all partners |
EU |
|
EU_UNREGISTERED_CHARITY |
The tax exemption document you provided doesn't include a charity name. Please upload a new document that includes your charity name as it's registered on your account. |
EU |
|
EU_UNREGISTERED_CHARITY_ MISSING_SUPPORTING_DOCUMENTS |
We received your government issued tax exemption document, but we also need a bank statement. Please upload a bank statement that shows the charity name. |
EU |
|
UK_CHARITY_DOCUMENTS |
We received your company house registration number, but we also need you to upload a government-issued tax exemption document for your charity. |
EU |
|
ES_CIF_CARD_REQUIRED |
The business document you provided is missing the business registration number. Please upload a copy of a CIF card showing your business registration number (no provisional numbers please) and electronic code. |
EU |
|
IT_BUSINESS_DOCUMENT_REA |
The business document you provided shows the regional number (REA). Please upload a new document containing a codice fiscale/partita di IVA (VISURA o Partita di IVA). |
EU |
|
SSN_INCOMPLETE_NUMBER |
The document you provided is missing the full SSN/ITIN number. Please upload a new document that includes the full 9-digit SSN/ITIN number. |
US |
|
DOCUMENT_EXPIRED_ OVER_12_MONTHS |
The document you provided wasn't issued within the last 12 months. Please upload a new document with the correct issue date. |
Global |
|
BUSINESS_POI_MISSING_ELEMENT |
The proof of business identity document you provided is missing some required information. Please upload a new business document that includes the business name registered on your account and the 9-digit TIN or EIN. |
US |
|
INITIALS_ON_DOCUMENT |
The document you provided includes only the initials of the first name. Please upload a new document that includes your full first and last name. |
Global |
|
PARTING_WAYS_ISSUED |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
POI_MISSING_DOB |
The proof of identity document you provided doesn't include the complete date of birth. Please upload a new document showing the entire date of birth. |
Global |
|
MISSING_BUSINESS_ADDRESS |
The proof of business address document provided contains a P.O. box. Unfortunately, we do not accept P.O. boxes as proof of address. Please upload a new document confirming your physical business address. |
Global |
|
WRONG_NAME_ON_DOCUMENT |
The document you provided doesn't include your name. Please upload a new document that includes your full name as shown on your account. |
Global |
|
NAME_CHANGE_LETTER_ MISSING_INFO |
The name change letter you provided is missing some of the required information. Please upload a new letter on company stationery showing:-Current and new contact name-Reason for the name change -Email address, postal address and phone number as shown on your account. |
Global |
|
PAU_IS_MINOR |
The contact person listed on the document you provided is a minor. The contact person must be at least 18 years old. To change the contact name, please upload a letter o company stationery showing:- Current and new contact names- Reason for the name change - Email address, postal address and phone number as registered on your account. Please ensure that Letter of Authorization for the new Contact Name is also provided. |
EU, RU, AU, JP, 3PL, MX, TH, US, C2 |
|
AU_CA_NICK_NAME_CHANGE |
The name on the document you provided doesn't match the name on your account. If you want to update the name on your account, please upload a bank statement for the bank account linked to your account along with a proof of address document. |
AU, CA |
|
BUSINESS_NAME_INSTEAD_ OF_PERSONAL_NAME |
The document you provided shows the name of your business and not the person's name. Please upload a new document showing the person's name. |
Global |
|
BUSINESS_POA_WITH_PERSON_NAME |
The proof of business address document you provided shows a person's name instead of the business name. Please upload a new document showing the business name. |
Global |
|
SU_INCOMPLETE_ADDRESS |
The address provided for the secondary user of the account is incomplete. Please provide a full home address for your secondary user. |
Global |
|
INDIVIDUAL_POA_MISSING_INFO |
The proof of address document you providing is missing some information. Please upload a new proof of address document showing the full name and residential address that matches the one on your account. |
Global |
|
DOCUMENT_ILLEGIBLE_ CANNOT_READ_INFORMATION |
The document you provided is illegible, because it's either too blurry, too bright, too dark, or the resolution is low. Please upload a new document that can be easily read. |
Global |
|
PDF_PASSWORD_PROTECTED |
We can't open the PDF you provided because it's password-protected. Please upload your document again without password protection or in a different format. |
Global |
|
BUSINESS_POA_MISSING_ELEMENT |
The proof of business address document you provided is missing some required information. Please upload a new proof of business address document issued within the last 12 months that includes the business name and physical business address registered on your account. |
US, TH |
|
BUSINESS_NAME_DOESNT_ MATCH_ACCT_INFO |
The business name on the document you provided doesn't match the business name registered on your account. Please upload a new proof of business identity document that includes the name registered on your account, or update the business name on your account. |
US, TH |
|
BUSINESS_NAME_AND_EIN_ DOESNT_MATCH_ACCT_INFO |
The business name and EIN shown in the document you provided doesn't match the EIN and business name on your account. Please upload a new proof of business identity document that includes the EIN and business name on your account. If you were trying to add information for a different business entity to the current account, please open a separate account for your new business. |
US |
|
BUSINESS_TYPE_ |
The business identity document you provided includes a business type that doesn't match the business type on your account. Please update the business type in your account to match what's shown on your documents, and then upload the original document again once you're done. |
US |
|
CLARIFY_BUSINESS_TYPE |
Please update the business type shown in your account to confirm if you are an Individual, Sole Proprietor or business entity (partnership, private limited, government entity, public company, etc.). Once the business type is updated, please upload your document again. |
US |
|
POA_IN_DIFFERENT_COUNTRY_ NEW_DOC_REQUIRED |
We can't accept the document you provided, because the address shown on the document is in a country different than the one on your account. Please upload a new document that includes the address shown in your account. |
Global |
|
DOC_NOT_IN_ENGLISH |
We can't accept the document you provided, because it's in a regional language. Please provide a copy of this document that's been translated to English and notarized by a government official. |
Global |
|
LOA_NOT_SIGNED_BY_ DIRECTOR_COMPANY_EXECUTIVE |
It looks like the person who signed the Letter of Authorisation is not listed as an Authorised Representative or Company Executive on your account. Please have your Letter of Authorisation signed by the correct stakeholder and re-submit. update_authorised.para=It looks like the person who signed the Letter of Authorisation is not listed as an Authorised Representative or Company Executive on your account. You'll need to add this stakeholder and re-submit. Once added, you can re-submit the Letter of Authorisation. complete_name.para=It looks like the info we received doesn't match the info on your account. To fix this, you need to upload a copy of a legal document (marriage certificate, divorce certificate, etc) to confirm your name change. You'll also need to upload copy of your passport with your new legal name.<br/><br/ |
EU |
|
LOA_UPDATE_AUTHORISED_ REPRESENTATIVE |
It looks like the person who signed the Letter of Authorisation is not listed as an Authorised Representative or Company Executive on your account. Please have your Letter of Authorisation signed by the correct stakeholder and re-submit. |
EU |
|
PARTING_WAYS_ISSUED_ FALSIFIED_DOCUMENTS |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PARTING_WAYS_ISSUED_ UNDERAGE_CUSTOMER |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PARTING_WAYS_ISSUED_ UNDERAGE_CUSTOMER_AT_SIGNUP |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PARTING_WAYS_ISSUED_FALSE_NAME |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PARTING_WAYS_ISSUED_ UNSUPPORTED_CITIZENSHIP |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
RU |
|
PARTING_WAYS_ISSUED_ UNSUPPORTED_COUNTRY |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PARTING_WAYS_ISSUED_ WRONG_COUNTRY |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PARTING_WAYS_ISSUED_ CROSS_JURIDSICTIONAL_ACCOUNT |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
EU |
|
PARTING_WAYS_ISSUED_ INACTIVE_BUSINESS |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
DOCUMENT_BLURRED_ CANNOT_READ_INFORMATION |
The document you provided is illegible, because it's either too blurry, too bright, too dark, or the resolution is low. Please upload a new document that can be easily read. |
US, C2 |
|
DOCUMENT_TOO_BRIGHT_ CANNOT_READ_INFORMATION |
The document you provided is illegible, because it's either too blurry, too bright, too dark, or the resolution is low. Please upload a new document that can be easily read. |
US, C2 |
|
POI_PORTRAIT_PHOTO_MISSING |
Your selfie could not be verified. Please complete a new selfie. Ensure there are no other individuals in the frame and that you are capturing an image of your face. |
US, C2 |
|
KEY_INFORMATION_TAMPERED_ OR_COVERED |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
US, C2 |
|
NON_POI_DOCUMENT |
No Content - Should be removed from scope |
US, C2 |
|
POI_DOB_DOES_NOT_MATCH |
No Content - Should be removed from scope |
US, C2 |
|
REJECTED_AND_CUSTOMIZED_ COMMUNICATION_NEEDED |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
CLOSED_ACCOUNT |
After reviewing the information you provided, we have decided not to proceed for security reasons. |
Global |
|
PPCC_CHARITABLE_ |
Please upload a document demonstrating your organization's charitable status, for example a certificate of tax exemption, or a document from the relevant regulator confirming that your organization's work benefits for general public. |
US |
|
DOC_ILLEGIBLE_UNABLE TO OPEN |
We are unable to accept the document provided either because is too blurry, too bright, too dark or we are unable to open the file. Please upload a new document that can be easily read. |
Global |
|
DOC_INFORMATION_MISMATCH |
The information on the <doc Type> provided does not match the information on your account. Please update the information on your account as required and upload a new document. |
US |
|
BANK_STATMENT_ REQ |
To complete our review please upload a bank statement for the bank account linked to your account. |
US |
|
VOIDED_CHECK_OR_ |
To complete our review, please provide the following documentation: - A copy of a bank statement or voided check that includes the charity or nonprofit organization's name and address pre-printed on it. Please send us a copy for a bank account you have registered your account. Please also note that any bank account you add to your account must be under the ownership of the charity/nonprofit organization and cannot be a personal bank account and must be active in your account. Please keep in mind that we reserve the right to ask additional questions on your policies and procedures. |
US |
|
BUSINESS_NAME_MISMATCH |
The business name on the documentation you provided does not match the Business name on your account. Please provide the following additional information: - A subordination letter on official letterhead from signed by an officer/director/trustee of the parent organization clearly stating that you are an authorized subordinate organization on behalf of the parent organization. Or If you have used a trading name or full legal business name, please provide the following additional information: - Written authorization on company letterhead, instructing us that you have used your trading name or full legal business name on your account. This letter must contain a company stamp and signature of a director or legal authorizer. Please keep in mind that we reserve the right to ask additional questions on your policies and procedures. |
US |
|
BUSINESS_NAME_IN_PAU_FIELD |
While reviewing your account, we were unable to verify the contact name on your account because it is listed as a business name. The contact name must be your name, not a business name. You can change the contact name on your account. To process your name, change request, we require additional information. Please provide: - Photo ID: You can use your driver's license, passport, or any other government issued photo ID. Please keep in mind that we reserve the right to ask additional questions on your policies and procedures. We look forward to hearing from you and thank you. |
US |
|
EIN_MISMATCH |
To complete our review, please complete the following: Update the EIN on your account to reflect the information on the document provided. Or Submit a tax exempt document matching Business name and EIN registered on the account. Please keep in mind that we reserve the right to ask additional questions on your policies and procedures. |
US |
Complete verification
Repeat steps 2-6 until the merchant passes all verification checks and all sections under the "capabilities" array shows "status: ACTIVE" with no limits.
1"capabilities":[2 {3 "name": "APPLE_PAY",4 "status": "ACTIVE"5 },6 {7 "name": "GOOGLE_PAY",8 "status": "ACTIVE"9 },10 {11 "name": "CUSTOM_CARD_PROCESSING",12 "status": "ACTIVE"13 },14 {15 "name": "RECEIVE_MONEY",16 "status": "ACTIVE"17 },18 {19 "name": "WITHDRAW_MONEY",20 "status": "ACTIVE"21 }22]