Sample account creation requests
Last updated: June 20th 2023, @ 12:08:42 pm
Note: The Managed Accounts API has been recently updated, to view the new version of sample account creation requests see Sample Account Creation Requests.
There are different requirements for creating accounts for merchants in the United States, the European Union, Australia, Canada, Indonesia, Japan, and the United Arab Emirates. This page provides examples of sample requests that you can use to create accounts for the following countries and business types.
Country options
United States
Sample requests
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
1{2 "external_id": "EXT-{{currentTime}}",3 "legal_country_code": "US",4 "organization": "us/marketplaces",5 "user_id": "{{currentTime}}",6 "primary_currency_code": "USD",7 "individual_owners": [8 {9 "names": [10 {11 "type": "LEGAL",12 "given_name": "JOHN",13 "surname": "WILLIAMSON"14 }15 ]16 }17 ],18 "business_entity": {19 "type": "CORPORATION",20 "names": [21 {22 "type": "LEGAL",23 "business_name": "Demo Inc."24 }25 ],26 "addresses": [27 {28 "type": "BUSINESS",29 "address_line_1": "1234 Lane1 Drive",30 "admin_area_2": "100",31 "postal_code": "95014",32 "country_code": "US"33 }34 ],35 "identification_documents": [36 {37 "type": "EMPLOYER_IDENTIFICATION_NUMBER",38 "identification_number": "123456789",39 "issuing_country_code": "US"40 }41 ],42 "declarations": [43 {44 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",45 "value": "NO"46 }47 ],48 "office_bearers": [49 {50 "role": "CHAIRMAN",51 "names": [52 {53 "type": "LEGAL",54 "given_name": "APPROVED",55 "surname": "TREASWILLIAMSON"56 }57 ],58 "addresses": [59 {60 "type": "HOME",61 "address_line_1": "644 N 100 E",62 "admin_area_2": "100",63 "postal_code": "29212",64 "country_code": "US"65 }66 ],67 "citizenship": "US",68 "birth_details": {69 "date_of_birth": "1995-05-30"70 },71 "identification_documents": [72 {73 "type": "SOCIAL_SECURITY_NUMBER",74 "identification_number": "111222343",75 "issuing_country_code": "US"76 }77 ]78 }79 ]80 },81 "agreements": [82 {83 "type": "TERMS_ACCEPTED",84 "accepted_time": "2012-01-01T10:30:02Z"85 }86 ]87 }
European Union
Sample requests
- Corporation
- Individual
- Nonprofit
- Proprietorship
- Public Company
- Government
- Public Corporation
1{2 "external_id": "EXT-{{currentTime}}",3 "legal_country_code": "GB",4 "organization": "eu/gb/ads",5 "user_id": "{{currentTime}}",6 "primary_currency_code": "EUR",7 "individual_owners": [8 {9 "names": [10 {11 "type": "LEGAL",12 "given_name": "Mary",13 "surname": "Collins"14 }15 ],16 "addresses": [17 {18 "type": "HOME",19 "address_line_1": "62 Jedburgh Road",20 "admin_area_2": "LENCHWICK",21 "postal_code": "WR11 0XJ",22 "country_code": "GB"23 }24 ],25 "citizenship": "GB",26 "birth_details": {27 "date_of_birth": "1990-01-01"28 }29 }30 ],31 "business_entity": {32 "type": "CORPORATION",33 "merchant_category_code": "5931",34 "names": [35 {36 "type": "LEGAL",37 "business_name": "Demo Inc."38 }39 ],40 "addresses": [41 {42 "type": "BUSINESS",43 "address_line_1": "62 Jedburgh Road",44 "admin_area_2": "LENCHWICK",45 "postal_code": "WR11 0XJ",46 "country_code": "GB"47 }48 ],49 "incorporation_details": {50 "date_of_incorporation": "2004-07-29",51 "incorporation_country_code": "GB"52 },53 "identification_documents": [54 {55 "type": "BUSINESS_REGISTRATION_NUMBER",56 "identification_number": "1234567890",57 "issuing_country_code": "GB"58 }59 ],60 "beneficial_owners": {61 "individuals": [62 {63 "percentage_of_ownership": "55",64 "names": [65 {66 "type": "LEGAL",67 "given_name": "James",68 "surname": "Collins",69 "suffix": "Jr"70 }71 ],72 "citizenship": "GB",73 "addresses": [74 {75 "type": "HOME",76 "address_line_1": "62 Jedburgh Road",77 "admin_area_2": "LENCHWICK",78 "postal_code": "WR11 0XJ",79 "country_code": "GB"80 }81 ],82 "birth_details": {83 "date_of_birth": "1985-01-01"84 }85 }86 ]87 },88 "office_bearers": [89 {90 "role": "DIRECTOR",91 "names": [92 {93 "type": "LEGAL",94 "prefix": "Mr.",95 "given_name": "Steve",96 "surname": "Collins",97 "suffix": "Sr"98 }99 ],100 "citizenship": "GB",101 "addresses": [102 {103 "type": "HOME",104 "address_line_1": "62 Jedburgh Road",105 "admin_area_2": "LENCHWICK",106 "postal_code": "WR11 0XJ",107 "country_code": "GB"108 }109 ],110 "birth_details": {111 "date_of_birth": "1990-01-01"112 }113 }114 ]115 },116 "agreements": [117 {118 "type": "TERMS_ACCEPTED",119 "accepted_time": "2022-01-01T10:30:02Z"120 }121 ]122 }
Australia
Sample requests
- Corporation
- Individual
- Nonprofit
- Proprietorship
- Public Company
- Government
- Public Corporation
1{2 "external_id": "EXT-{{currentTime}}",3 "legal_country_code": "AU",4 "organization": "au/instagram",5 "user_id": "{{currentTime}}",6 "primary_currency_code": "AUD",7 "individual_owners": [8 {9 "names": [10 {11 "type": "LEGAL",12 "given_name": "Mary",13 "surname": "Collins"14 }15 ]16 }17 ],18 "business_entity": {19 "type": "CORPORATION",20 "names": [21 {22 "type": "LEGAL",23 "business_name": "Demo Inc."24 }25 ]26 },27 "agreements": [28 {29 "type": "TERMS_ACCEPTED",30 "accepted_time": "2022-01-01T10:30:02Z"31 }32 ]33 }
Canada
Sample requests
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
1{2 "external_id": "EXT-{{currentTime}}",3 "legal_country_code": "CA",4 "organization": "ca/events",5 "user_id": "{{currentTime}}",6 "primary_currency_code": "CAD",7 "individual_owners": [8 {9 "names": [10 {11 "type": "LEGAL",12 "given_name": "Mary",13 "surname": "Collins"14 }15 ]16 }17 ],18 "business_entity": {19 "type": "CORPORATION",20 "names": [21 {22 "type": "LEGAL",23 "business_name": "Demo Inc."24 }25 ],26 "addresses": [27 {28 "type": "BUSINESS",29 "address_line_1": "357 Walnut Dr",30 "address_line_2": "addresses",31 "admin_area_1": "NB",32 "admin_area_2": "Salisbury",33 "postal_code": "E4J 0V6",34 "country_code": "CA"35 }36 ],37 "identification_documents": [38 {39 "type": "BUSINESS_REGISTRATION_NUMBER",40 "identification_number": "36554654",41 "issuing_country_code": "CA"42 }43 ]44 },45 "agreements": [46 {47 "type": "TERMS_ACCEPTED",48 "accepted_time": "2022-01-01T10:30:02Z"49 }50 ]51 }
Indonesia
Sample requests
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "external_id": "EXT-499025",3 "legal_country_code": "ID",4 "organization": "indonesia",5 "primary_currency_code": "USD",6 "individual_owners": [7 {8 "names": [9 {10 "type": "LEGAL",11 "given_name": "MaryAPPROVED",12 "surname": "Collins"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "names": [20 {21 "type": "LEGAL",22 "business_name": "Demo Inc."23 }24 ]25 },26 "agreements": [27 {28 "type": "TERMS_ACCEPTED",29 "accepted_time": "2019-06-02T01:23:45Z"30 }31 ]32}
Sample Responses
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "account_id": "7CYQ3EFKLR32W",3 "legal_country_code": "ID",4 "individual_owners": [5 {6 "id": "7CYQ3EFKLR32W",7 "names": [8 {9 "given_name": "MaryAPPROVED",10 "surname": "Collins",11 "id": "JATBHBNGG9YMC",12 "type": "LEGAL"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "incorporation_details": {},20 "names": [21 {22 "business_name": "Demo Inc.",23 "id": "SCLQR4N5HPKXW",24 "type": "LEGAL"25 }26 ]27 },28 "agreements": [29 {30 "type": "TERMS_ACCEPTED",31 "accepted_time": "2019-06-02T01:23:45Z"32 }33 ],34 "external_id": "EXT-499025",35 "organization": "indonesia",36 "primary_currency_code": "USD",37 "soft_descriptor": "DEMO INC",38 "capabilities": [39 {40 "name": "RECEIVE_MONEY",41 "status": "ACTIVE"42 },43 {44 "name": "PAYPAL_CHECKOUT",45 "status": "ACTIVE"46 }47 ],48 "links": [49 {50 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/7CYQ3EFKLR32W",51 "rel": "self",52 "method": "GET"53 },54 {55 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/7CYQ3EFKLR32W",56 "rel": "edit",57 "method": "PATCH"58 }59 ]60}
Maximum payload example
1{2 "external_id": "EXT-1649440654255",3 "legal_country_code": "ID",4 "organization": "indonesia",5 "user_id": "1649440654255",6 "primary_currency_code": "USD",7 "soft_descriptor": "DemoInc",8 "individual_owners": [9 {10 "names": [11 {12 "type": "LEGAL",13 "given_name": "MaryAPPROVED",14 "surname": "Collins"15 }16 ],17 "citizenship": "ID",18 "gender": "FEMALE",19 "primary_residence": {20 "address_line_1": "Dki Jakarta",21 "admin_area_1": "Jawa",22 "admin_area_2": "Jakarta",23 "postal_code": "50519",24 "country_code": "ID"25 },26 "tax_address": {27 "address_line_1": "Jl Soekarno Hatta 234",28 "admin_area_1": "Jawa",29 "admin_area_2": "Bandung",30 "postal_code": "50519",31 "country_code": "ID"32 },33 "addresses": [34 {35 "type": "HOME",36 "address_line_1": "Jl Mangga Besar Raya 85",37 "admin_area_1": "Dki Jakarta",38 "admin_area_2": "Jakarta",39 "postal_code": "50519",40 "country_code": "ID"41 }42 ],43 "phone_numbers": [44 {45 "country_code": "62",46 "national_number": "3939249447",47 "type": "MOBILE"48 }49 ],50 "birth_details": {51 "date_of_birth": "1960-01-01"52 },53 "identification_documents": [54 {55 "identification_number": "123456789",56 "issue_date": "2020-01-01",57 "expiry_date": "2025-01-01",58 "issuing_country_code": "ID",59 "type": "PASSPORT"60 }61 ],62 "emails": [63 {64 "email": "test_account_admin@paypal.com"65 }66 ],67 "agreements": [68 {69 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",70 "accepted_time": "2019-06-02T01:23:45Z",71 "signature": "Mary Collins"72 }73 ]74 }75 ],76 "business_entity": {77 "type": "INDIVIDUAL",78 "merchant_category_code": "4121",79 "names": [80 {81 "type": "LEGAL",82 "business_name": "Demo Inc."83 },84 {85 "type": "DOING_BUSINESS_AS",86 "business_name": "Demo DBA Inc."87 }88 ],89 "emails": [90 {91 "email": "test_account_admin_business@paypal.com"92 }93 ],94 "website": "paypal.com",95 "registered_business_address": {96 "type": "BUSINESS",97 "address_line_1": "Jl Mangga Besar Raya 85",98 "admin_area_1": "Jawa",99 "admin_area_2": "Jakarta",100 "postal_code": "50519",101 "country_code": "ID"102 },103 "principal_office_address": {104 "address_line_1": "Jl Soekarno Hatta 234",105 "admin_area_1": "Dki Jakarta",106 "admin_area_2": "Jakarta",107 "postal_code": "50519",108 "country_code": "ID"109 },110 "tax_address": {111 "address_line_1": "Jl Soekarno Hatta 234",112 "admin_area_1": "Jawa",113 "admin_area_2": "Bandung",114 "postal_code": "50519",115 "country_code": "ID"116 },117 "addresses": [118 {119 "address_line_1": "Jl Mangga Besar Raya 85",120 "admin_area_1": "Dki Jakarta",121 "admin_area_2": "Jakarta",122 "postal_code": "50519",123 "country_code": "ID",124 "type": "MAILING"125 }126 ],127 "identification_documents": [128 {129 "identification_number": "8000012050001",130 "issue_date": "2020-01-01",131 "issuing_country_code": "ID",132 "type": "BUSINESS_REGISTRATION_NUMBER"133 }134 ],135 "incorporation_details": {136 "incorporation_country_code": "ID",137 "incorporation_date": "2019-01-01",138 "incorporation_province_code": "O1"139 },140 "phone_numbers": [141 {142 "country_code": "62",143 "national_number": "3939249447",144 "type": "BUSINESS"145 }146 ],147 "beneficial_owners": {148 "individuals": [149 {150 "percentage_of_ownership": "25",151 "names": [152 {153 "type": "LEGAL",154 "given_name": "MaryAPPROVED",155 "surname": "Collins"156 }157 ],158 "citizenship": "ID",159 "gender": "FEMALE",160 "primary_residence": {161 "address_line_1": "Jl Mangga Besar Raya 85",162 "admin_area_1": "Dki Jakarta",163 "admin_area_2": "Jakarta",164 "postal_code": "50519",165 "country_code": "ID"166 },167 "tax_address": {168 "address_line_1": "Jl Soekarno Hatta 234",169 "admin_area_1": "Jawa",170 "admin_area_2": "Bandung",171 "postal_code": "50519",172 "country_code": "ID"173 },174 "addresses": [175 {176 "type": "HOME",177 "address_line_1": "Dki Jakarta",178 "admin_area_1": "Dki Jakarta",179 "admin_area_2": "Jakarta",180 "postal_code": "50519",181 "country_code": "ID"182 }183 ],184 "birth_details": {185 "date_of_birth": "1960-01-01"186 },187 "identification_documents": [188 {189 "identification_number": "123456789",190 "issue_date": "2020-01-01",191 "expiry_date": "2025-01-01",192 "issuing_country_code": "ID",193 "type": "PASSPORT"194 }195 ],196 "emails": [197 {198 "email": "test_account_admin@paypal.com"199 }200 ],201 "agreements": [202 {203 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",204 "accepted_time": "2019-06-02T01:23:45Z",205 "signature": "Mary Collins"206 }207 ],208 "declarations": [209 {210 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",211 "value": "YES"212 }213 ]214 }215 ],216 "office_bearers": [217 {218 "role": "CEO",219 "names": [220 {221 "type": "LEGAL",222 "given_name": "MaryAPPROVED",223 "surname": "Collins"224 }225 ],226 "citizenship": "ID",227 "gender": "FEMALE",228 "primary_residence": {229 "address_line_1": "Dki Jakarta",230 "admin_area_1": "Dki Jakarta",231 "admin_area_2": "Jakarta",232 "postal_code": "50519",233 "country_code": "ID"234 },235 "tax_address": {236 "address_line_1": "Jawa",237 "admin_area_1": "Jawa",238 "admin_area_2": "Bandung",239 "postal_code": "50519",240 "country_code": "ID"241 },242 "addresses": [243 {244 "type": "HOME",245 "address_line_1": "Dki Jakarta",246 "admin_area_1": "Dki Jakarta",247 "admin_area_2": "Jakarta",248 "postal_code": "50519",249 "country_code": "ID"250 }251 ],252 "birth_details": {253 "date_of_birth": "1960-01-01"254 },255 "identification_documents": [256 {257 "identification_number": "123456789",258 "issue_date": "2020-01-01",259 "expiry_date": "2025-01-01",260 "issuing_country_code": "ID",261 "type": "PASSPORT"262 }263 ],264 "emails": [265 {266 "email": "test_account_admin@paypal.com"267 }268 ],269 "agreements": [270 {271 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",272 "accepted_time": "2019-06-02T01:23:45Z",273 "signature": "Mary Collins"274 }275 ]276 }277 ]278 }279 },280 "agreements": [281 {282 "type": "TERMS_ACCEPTED",283 "accepted_time": "2019-06-02T01:23:45Z"284 }285 ]286}
Japan
Sample requests
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "external_id": "EXT-463430",3 "legal_country_code": "JP",4 "organization": "japan",5 "primary_currency_code": "JPY",6 "individual_owners": [7 {8 "names": [9 {10 "type": "LEGAL",11 "given_name": "MaryAPPROVED",12 "surname": "Collins"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "names": [20 {21 "type": "LEGAL",22 "business_name": "Demo Inc."23 }24 ]25 },26 "agreements": [27 {28 "type": "TERMS_ACCEPTED",29 "accepted_time": "2019-06-02T01:23:45Z"30 }31 ]32}
Sample Responses
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "account_id": "GTEXV87ANEC3S",3 "legal_country_code": "JP",4 "individual_owners": [5 {6 "id": "GTEXV87ANEC3S",7 "names": [8 {9 "given_name": "MaryAPPROVED",10 "surname": "Collins",11 "id": "Y3VG8Z9BDNXA6",12 "type": "LEGAL"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "incorporation_details": {},20 "names": [21 {22 "business_name": "Demo Inc.",23 "id": "BWK5VZPVZPMT4",24 "type": "LEGAL"25 }26 ]27 },28 "agreements": [29 {30 "type": "TERMS_ACCEPTED",31 "accepted_time": "2019-06-02T01:23:45Z"32 }33 ],34 "external_id": "EXT-463430",35 "organization": "japan",36 "primary_currency_code": "JPY",37 "soft_descriptor": "DEMO INC",38 "capabilities": [39 {40 "name": "RECEIVE_MONEY",41 "status": "ACTIVE"42 },43 {44 "name": "PAYPAL_CHECKOUT",45 "status": "ACTIVE"46 }47 ],48 "links": [49 {50 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/GTEXV87ANEC3S",51 "rel": "self",52 "method": "GET"53 },54 {55 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/GTEXV87ANEC3S",56 "rel": "edit",57 "method": "PATCH"58 }59 ]60}
Maximum payload example
1{2 "external_id": "EXT-{{currentTime}}",3 "legal_country_code": "JP",4 "organization": "japan",5 "user_id": "{{currentTime}}",6 "primary_currency_code": "JPY",7 "soft_descriptor": "DemoInc",8 "individual_owners": [9 {10 "names": [11 {12 "type": "LEGAL",13 "given_name": "MaryAPPROVED",14 "surname": "Collins"15 }16 ],17 "citizenship": "JP",18 "gender": "FEMALE",19 "primary_residence": {20 "address_line_1": "2-543 Aza Hagidaira, Kawaji",21 "admin_area_2": "Miyazaki-Shi",22 "admin_area_1": "OT",23 "postal_code": "880-0911",24 "country_code": "JP"25 },26 "tax_address": {27 "address_line_1": "Nishi 0-Chome, Kita 13-Jo, Kita-Ku",28 "admin_area_1": "O4",29 "admin_area_2": "Uwajima-Shi",30 "postal_code": "798-0022",31 "country_code": "JP"32 },33 "addresses": [34 {35 "type": "HOME",36 "address_line_1": "5774 Tominokojidori Ayanokojisagaru, Nushiya-Cho, Shimogyo-Ku",37 "admin_area_1": "26",38 "admin_area_2": "Kawanehon-Cho",39 "postal_code": "428-0417",40 "country_code": "JP"41 }42 ],43 "phone_numbers": [44 {45 "country_code": "81",46 "national_number": "3939249447",47 "type": "MOBILE"48 }49 ],50 "birth_details": {51 "date_of_birth": "1960-01-01"52 },53 "identification_documents": [54 {55 "identification_number": "123456789",56 "issue_date": "2020-01-01",57 "expiry_date": "2025-01-01",58 "issuing_country_code": "JP",59 "type": "PASSPORT"60 }61 ],62 "emails": [63 {64 "email": "test_account_admin@paypal.com"65 }66 ],67 "agreements": [68 {69 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",70 "accepted_time": "2019-06-02T01:23:45Z",71 "signature": "Mary Collins"72 }73 ]74 }75 ],76 "business_entity": {77 "type": "INDIVIDUAL",78 "merchant_category_code": "4121",79 "names": [80 {81 "type": "LEGAL",82 "business_name": "Demo Inc."83 },84 {85 "type": "DOING_BUSINESS_AS",86 "business_name": "Demo DBA Inc."87 }88 ],89 "emails": [90 {91 "email": "test_account_admin_business@paypal.com"92 }93 ],94 "website": "paypal.com",95 "registered_business_address": {96 "type": "BUSINESS",97 "address_line_1": "9278-6 Oaza Tayoshi",98 "admin_area_1": "O4",99 "admin_area_2": "Uwajima-Shi",100 "postal_code": "798-0022",101 "country_code": "JP"102 },103 "principal_office_address": {104 "address_line_1": "800055-9096 Kisshoin-Ishihara-Nagata",105 "admin_area_1": "OT",106 "admin_area_2": "Miyazaki-Shi",107 "postal_code": "880-0911",108 "country_code": "JP"109 },110 "tax_address": {111 "address_line_1": "2-9-1 Yata, Higashisumiyoshi-Ku",112 "admin_area_1": "OP",113 "admin_area_2": "Kyoto-Shi",114 "postal_code": "600-8053",115 "country_code": "JP"116 },117 "addresses": [118 {119 "address_line_1": "2679-761-163Matsushima",120 "admin_area_1": "O2",121 "admin_area_2": "Hirosaki-Shi",122 "postal_code": "036-8503",123 "country_code": "JP",124 "type": "MAILING"125 }126 ],127 "identification_documents": [128 {129 "identification_number": "8000012050001",130 "issue_date": "2020-01-01",131 "issuing_country_code": "JP",132 "type": "BUSINESS_REGISTRATION_NUMBER"133 }134 ],135 "incorporation_details": {136 "incorporation_country_code": "JP",137 "incorporation_date": "2019-01-01",138 "incorporation_province_code": "O1"139 },140 "phone_numbers": [141 {142 "country_code": "81",143 "national_number": "3939249447",144 "type": "BUSINESS"145 }146 ],147 "beneficial_owners": {148 "individuals": [149 {150 "percentage_of_ownership": "25",151 "names": [152 {153 "type": "LEGAL",154 "given_name": "MaryAPPROVED",155 "surname": "Collins"156 }157 ],158 "citizenship": "JP",159 "gender": "FEMALE",160 "primary_residence": {161 "address_line_1": "Kusayama Bldg. 2F, 507-66-577",162 "admin_area_1": "OB",163 "admin_area_2": "Sapporo-Shi",164 "postal_code": "060-0812",165 "country_code": "JP"166 },167 "tax_address": {168 "address_line_1": "Kusayama Bldg. 8F, 107-57-869",169 "admin_area_1": "21",170 "admin_area_2": "Osaka-Shi",171 "postal_code": "546-0023",172 "country_code": "JP"173 },174 "addresses": [175 {176 "type": "HOME",177 "address_line_1": "4979 Tominokojidori Ayanokojisagaru, Nushiya-Cho, Shimogyo-Ku",178 "admin_area_1": "27",179 "admin_area_2": "Utsunomiya-Shi",180 "postal_code": "321-0346",181 "country_code": "JP"182 }183 ],184 "birth_details": {185 "date_of_birth": "1960-01-01"186 },187 "identification_documents": [188 {189 "identification_number": "123456789",190 "issue_date": "2020-01-01",191 "expiry_date": "2025-01-01",192 "issuing_country_code": "JP",193 "type": "PASSPORT"194 }195 ],196 "emails": [197 {198 "email": "test_account_admin@paypal.com"199 }200 ],201 "agreements": [202 {203 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",204 "accepted_time": "2019-06-02T01:23:45Z",205 "signature": "Mary Collins"206 }207 ],208 "declarations": [209 {210 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",211 "value": "YES"212 }213 ]214 }215 ],216 "office_bearers": [217 {218 "role": "CEO",219 "names": [220 {221 "type": "LEGAL",222 "given_name": "MaryAPPROVED",223 "surname": "Collins"224 }225 ],226 "citizenship": "JP",227 "gender": "FEMALE",228 "primary_residence": {229 "address_line_1": "3610 Nagasaka, Shimoarahari-Machi",230 "admin_area_1": "21",231 "admin_area_2": "Osaka-Shi",232 "postal_code": "546-0023",233 "country_code": "JP"234 },235 "tax_address": {236 "address_line_1": "4760 Tominokojidori Ayanokojisagaru, Nushiya-Cho, Shimogyo-Ku",237 "admin_area_1": "O3",238 "admin_area_2": "Ichikawa-Shi",239 "postal_code": "272-0138",240 "country_code": "JP"241 },242 "addresses": [243 {244 "type": "HOME",245 "address_line_1": "6592 Baba, Ibuki-Cho",246 "admin_area_1": "27",247 "admin_area_2": "Utsunomiya-Shi",248 "postal_code": "321-0346",249 "country_code": "JP"250 }251 ],252 "birth_details": {253 "date_of_birth": "1960-01-01"254 },255 "identification_documents": [256 {257 "identification_number": "123456789",258 "issue_date": "2020-01-01",259 "expiry_date": "2025-01-01",260 "issuing_country_code": "JP",261 "type": "PASSPORT"262 }263 ],264 "emails": [265 {266 "email": "test_account_admin@paypal.com"267 }268 ],269 "agreements": [270 {271 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",272 "accepted_time": "2019-06-02T01:23:45Z",273 "signature": "Mary Collins"274 }275 ]276 }277 ]278 }279 },280 "agreements": [281 {282 "type": "TERMS_ACCEPTED",283 "accepted_time": "2019-06-02T01:23:45Z"284 }285 ]286}
South Africa
Sample requests
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 {3 "external_id": "EXT-1649382589211",4 "legal_country_code": "ZA",5 "organization": "south_africa",6 "primary_currency_code": "USD",7 "individual_owners": [8 {9 "names": [10 {11 "type": "LEGAL",12 "given_name": "MaryAPPROVED",13 "surname": "Collins"14 }15 ]16 }17 ],18 "business_entity": {19 "type": "CORPORATION",20 "names": [21 {22 "type": "LEGAL",23 "business_name": "Demo Inc."24 }25 ]26 },27 "agreements": [28 {29 "type": "TERMS_ACCEPTED",30 "accepted_time": "2019-06-02T01:23:45Z"31 }32 ]33}
Sample Responses
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "account_id": "WXHJ2JFC6BEVA",3 "legal_country_code": "ZA",4 "individual_owners": [5 {6 "id": "WXHJ2JFC6BEVA",7 "names": [8 {9 "given_name": "MaryAPPROVED",10 "surname": "Collins",11 "id": "EDBXMF49KHQ58",12 "type": "LEGAL"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "incorporation_details": {},20 "names": [21 {22 "business_name": "Demo Inc.",23 "id": "JVP953GR7QLNY",24 "type": "LEGAL"25 }26 ]27 },28 "agreements": [29 {30 "type": "TERMS_ACCEPTED",31 "accepted_time": "2019-06-02T01:23:45Z"32 }33 ],34 "external_id": "EXT-1649382589211",35 "organization": "south_africa",36 "primary_currency_code": "USD",37 "soft_descriptor": "DEMO INC",38 "capabilities": [39 {40 "name": "RECEIVE_MONEY",41 "status": "ACTIVE"42 },43 {44 "name": "PAYPAL_CHECKOUT",45 "status": "ACTIVE"46 }47 ],48 "links": [49 {50 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/WXHJ2JFC6BEVA",51 "rel": "self",52 "method": "GET"53 },54 {55 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/WXHJ2JFC6BEVA",56 "rel": "edit",57 "method": "PATCH"58 }59 ]60}
Maximum payload example
- Sample Full Request
- Sample Full Response
1{2 "external_id": "EXT-1649441958176",3 "legal_country_code": "ZA",4 "organization": "south_africa",5 "user_id": "1649441958176",6 "primary_currency_code": "USD",7 "soft_descriptor": "DemoInc",8 "individual_owners": [9 {10 "names": [11 {12 "type": "LEGAL",13 "given_name": "MaryAPPROVED",14 "surname": "Collins"15 }16 ],17 "citizenship": "ZA",18 "gender": "FEMALE",19 "primary_residence": {20 "address_line_1": "Mkhuhlu",21 "admin_area_1": "Silverton",22 "admin_area_2": "Mpumalanga",23 "postal_code": "8301",24 "country_code": "ZA"25 },26 "tax_address": {27 "address_line_1": "1681 Glyn St",28 "admin_area_1": "Silverton",29 "admin_area_2": "Gauteng",30 "postal_code": "8301",31 "country_code": "ZA"32 },33 "addresses": [34 {35 "type": "HOME",36 "address_line_1": "706 Ireland St",37 "admin_area_1": "Mkhuhlu",38 "admin_area_2": "Mpumalanga",39 "postal_code": "8301",40 "country_code": "ZA"41 }42 ],43 "phone_numbers": [44 {45 "country_code": "27",46 "national_number": "3939249447",47 "type": "MOBILE"48 }49 ],50 "birth_details": {51 "date_of_birth": "1960-01-01"52 },53 "identification_documents": [54 {55 "identification_number": "123456789",56 "issue_date": "2020-01-01",57 "expiry_date": "2025-01-01",58 "issuing_country_code": "ZA",59 "type": "PASSPORT"60 }61 ],62 "emails": [63 {64 "email": "test_account_admin@paypal.com"65 }66 ],67 "agreements": [68 {69 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",70 "accepted_time": "2019-06-02T01:23:45Z",71 "signature": "Mary Collins"72 }73 ]74 }75 ],76 "business_entity": {77 "type": "INDIVIDUAL",78 "merchant_category_code": "4121",79 "names": [80 {81 "type": "LEGAL",82 "business_name": "Demo Inc."83 },84 {85 "type": "DOING_BUSINESS_AS",86 "business_name": "Demo DBA Inc."87 }88 ],89 "emails": [90 {91 "email": "test_account_admin_business@paypal.com"92 }93 ],94 "website": "paypal.com",95 "registered_business_address": {96 "type": "BUSINESS",97 "address_line_1": "706 Ireland St",98 "admin_area_1": "Silverton",99 "admin_area_2": "Mpumalanga",100 "postal_code": "8301",101 "country_code": "ZA"102 },103 "principal_office_address": {104 "address_line_1": "1681 Glyn St",105 "admin_area_1": "Mkhuhlu",106 "admin_area_2": "Mpumalanga",107 "postal_code": "8301",108 "country_code": "ZA"109 },110 "tax_address": {111 "address_line_1": "1681 Glyn St",112 "admin_area_1": "Silverton",113 "admin_area_2": "Gauteng",114 "postal_code": "8301",115 "country_code": "ZA"116 },117 "addresses": [118 {119 "address_line_1": "706 Ireland St",120 "admin_area_1": "Mkhuhlu",121 "admin_area_2": "Mpumalanga",122 "postal_code": "8301",123 "country_code": "ZA",124 "type": "MAILING"125 }126 ],127 "identification_documents": [128 {129 "identification_number": "8000012050001",130 "issue_date": "2020-01-01",131 "issuing_country_code": "ZA",132 "type": "BUSINESS_REGISTRATION_NUMBER"133 }134 ],135 "incorporation_details": {136 "incorporation_country_code": "ZA",137 "incorporation_date": "2019-01-01",138 "incorporation_province_code": "O1"139 },140 "phone_numbers": [141 {142 "country_code": "27",143 "national_number": "3939249447",144 "type": "BUSINESS"145 }146 ],147 "beneficial_owners": {148 "individuals": [149 {150 "percentage_of_ownership": "25",151 "names": [152 {153 "type": "LEGAL",154 "given_name": "MaryAPPROVED",155 "surname": "Collins"156 }157 ],158 "citizenship": "ZA",159 "gender": "FEMALE",160 "primary_residence": {161 "address_line_1": "706 Ireland St",162 "admin_area_1": "Mkhuhlu",163 "admin_area_2": "Mpumalanga",164 "postal_code": "8301",165 "country_code": "ZA"166 },167 "tax_address": {168 "address_line_1": "1681 Glyn St",169 "admin_area_1": "Silverton",170 "admin_area_2": "Gauteng",171 "postal_code": "8301",172 "country_code": "ZA"173 },174 "addresses": [175 {176 "type": "HOME",177 "address_line_1": "Mkhuhlu",178 "admin_area_1": "Mkhuhlu",179 "admin_area_2": "Mpumalanga",180 "postal_code": "8301",181 "country_code": "ZA"182 }183 ],184 "birth_details": {185 "date_of_birth": "1960-01-01"186 },187 "identification_documents": [188 {189 "identification_number": "123456789",190 "issue_date": "2020-01-01",191 "expiry_date": "2025-01-01",192 "issuing_country_code": "ZA",193 "type": "PASSPORT"194 }195 ],196 "emails": [197 {198 "email": "test_account_admin@paypal.com"199 }200 ],201 "agreements": [202 {203 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",204 "accepted_time": "2019-06-02T01:23:45Z",205 "signature": "Mary Collins"206 }207 ],208 "declarations": [209 {210 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",211 "value": "YES"212 }213 ]214 }215 ],216 "office_bearers": [217 {218 "role": "CEO",219 "names": [220 {221 "type": "LEGAL",222 "given_name": "MaryAPPROVED",223 "surname": "Collins"224 }225 ],226 "citizenship": "ZA",227 "gender": "FEMALE",228 "primary_residence": {229 "address_line_1": "Mkhuhlu",230 "admin_area_1": "Mkhuhlu",231 "admin_area_2": "Mpumalanga",232 "postal_code": "8301",233 "country_code": "ZA"234 },235 "tax_address": {236 "address_line_1": "Silverton",237 "admin_area_1": "Silverton",238 "admin_area_2": "Gauteng",239 "postal_code": "8301",240 "country_code": "ZA"241 },242 "addresses": [243 {244 "type": "HOME",245 "address_line_1": "Mkhuhlu",246 "admin_area_1": "Mkhuhlu",247 "admin_area_2": "Mpumalanga",248 "postal_code": "8301",249 "country_code": "ZA"250 }251 ],252 "birth_details": {253 "date_of_birth": "1960-01-01"254 },255 "identification_documents": [256 {257 "identification_number": "123456789",258 "issue_date": "2020-01-01",259 "expiry_date": "2025-01-01",260 "issuing_country_code": "ZA",261 "type": "PASSPORT"262 }263 ],264 "emails": [265 {266 "email": "test_account_admin@paypal.com"267 }268 ],269 "agreements": [270 {271 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",272 "accepted_time": "2019-06-02T01:23:45Z",273 "signature": "Mary Collins"274 }275 ]276 }277 ]278 }279 },280 "agreements": [281 {282 "type": "TERMS_ACCEPTED",283 "accepted_time": "2019-06-02T01:23:45Z"284 }285 ]286}
United Arab Emirates
Sample requests
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "external_id": "EXT-1649379593429",3 "legal_country_code": "AE",4 "organization": "uae-ppcb",5 "primary_currency_code": "USD",6 "individual_owners": [7 {8 "names": [9 {10 "type": "LEGAL",11 "given_name": "MaryAPPROVED",12 "surname": "Collins"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "names": [20 {21 "type": "LEGAL",22 "business_name": "Demo Inc."23 }24 ]25 },26 "agreements": [27 {28 "type": "TERMS_ACCEPTED",29 "accepted_time": "2019-06-02T01:23:45Z"30 }31 ]32}
Sample Responses
- Corporation
- Individual
- Nonprofit
- Private Corporation
- Proprietorship
- Public Company
- Government
- Association
- Other Corporate Body
- Partnership
- Proprietory Company
- Registered Cooperative
1{2 "account_id": "Q9PMZ5T33X9U6",3 "legal_country_code": "AE",4 "individual_owners": [5 {6 "id": "Q9PMZ5T33X9U6",7 "names": [8 {9 "given_name": "MaryAPPROVED",10 "surname": "Collins",11 "id": "2KVMCZCSWKVFS",12 "type": "LEGAL"13 }14 ]15 }16 ],17 "business_entity": {18 "type": "CORPORATION",19 "incorporation_details": {},20 "names": [21 {22 "business_name": "Demo Inc.",23 "id": "KVGGJ5LTPXAKS",24 "type": "LEGAL"25 }26 ]27 },28 "agreements": [29 {30 "type": "TERMS_ACCEPTED",31 "accepted_time": "2019-06-02T01:23:45Z"32 }33 ],34 "external_id": "EXT-1649379593429",35 "organization": "uae-ppcb",36 "primary_currency_code": "USD",37 "soft_descriptor": "DEMO INC",38 "capabilities": [39 {40 "name": "RECEIVE_MONEY",41 "status": "ACTIVE"42 },43 {44 "name": "PAYPAL_CHECKOUT",45 "status": "ACTIVE"46 }47 ],48 "links": [49 {50 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/Q9PMZ5T33X9U6",51 "rel": "self",52 "method": "GET"53 },54 {55 "href": "https://sandbox.qa.paypal.com/v3/customer/managed-accounts/Q9PMZ5T33X9U6",56 "rel": "edit",57 "method": "PATCH"58 }59 ]60}
Maximum payload example
1{2 "external_id": "EXT-1649441958176",3 "legal_country_code": "AE",4 "organization": "uae-ppcb",5 "user_id": "1649441958176",6 "primary_currency_code": "USD",7 "soft_descriptor": "DemoInc",8 "individual_owners": [9 {10 "names": [11 {12 "type": "LEGAL",13 "given_name": "MaryAPPROVED",14 "surname": "Collins"15 }16 ],17 "citizenship": "ZA",18 "gender": "FEMALE",19 "primary_residence": {20 "address_line_1": "Mkhuhlu",21 "admin_area_1": "Silverton",22 "admin_area_2": "Mpumalanga",23 "postal_code": "8301",24 "country_code": "ZA"25 },26 "tax_address": {27 "address_line_1": "1681 Glyn St",28 "admin_area_1": "Silverton",29 "admin_area_2": "Gauteng",30 "postal_code": "8301",31 "country_code": "ZA"32 },33 "addresses": [34 {35 "type": "HOME",36 "address_line_1": "706 Ireland St",37 "admin_area_1": "Mkhuhlu",38 "admin_area_2": "Mpumalanga",39 "postal_code": "8301",40 "country_code": "ZA"41 }42 ],43 "phone_numbers": [44 {45 "country_code": "27",46 "national_number": "3939249447",47 "type": "MOBILE"48 }49 ],50 "birth_details": {51 "date_of_birth": "1960-01-01"52 },53 "identification_documents": [54 {55 "identification_number": "123456789",56 "issue_date": "2020-01-01",57 "expiry_date": "2025-01-01",58 "issuing_country_code": "ZA",59 "type": "PASSPORT"60 }61 ],62 "emails": [63 {64 "email": "test_account_admin@paypal.com"65 }66 ],67 "agreements": [68 {69 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",70 "accepted_time": "2019-06-02T01:23:45Z",71 "signature": "Mary Collins"72 }73 ]74 }75 ],76 "business_entity": {77 "type": "INDIVIDUAL",78 "merchant_category_code": "4121",79 "names": [80 {81 "type": "LEGAL",82 "business_name": "Demo Inc."83 },84 {85 "type": "DOING_BUSINESS_AS",86 "business_name": "Demo DBA Inc."87 }88 ],89 "emails": [90 {91 "email": "test_account_admin_business@paypal.com"92 }93 ],94 "website": "paypal.com",95 "registered_business_address": {96 "type": "BUSINESS",97 "address_line_1": "706 Ireland St",98 "admin_area_1": "Silverton",99 "admin_area_2": "Mpumalanga",100 "postal_code": "8301",101 "country_code": "ZA"102 },103 "principal_office_address": {104 "address_line_1": "1681 Glyn St",105 "admin_area_1": "Mkhuhlu",106 "admin_area_2": "Mpumalanga",107 "postal_code": "8301",108 "country_code": "ZA"109 },110 "tax_address": {111 "address_line_1": "1681 Glyn St",112 "admin_area_1": "Silverton",113 "admin_area_2": "Gauteng",114 "postal_code": "8301",115 "country_code": "ZA"116 },117 "addresses": [118 {119 "address_line_1": "706 Ireland St",120 "admin_area_1": "Mkhuhlu",121 "admin_area_2": "Mpumalanga",122 "postal_code": "8301",123 "country_code": "ZA",124 "type": "MAILING"125 }126 ],127 "identification_documents": [128 {129 "identification_number": "8000012050001",130 "issue_date": "2020-01-01",131 "issuing_country_code": "ZA",132 "type": "BUSINESS_REGISTRATION_NUMBER"133 }134 ],135 "incorporation_details": {136 "incorporation_country_code": "ZA",137 "incorporation_date": "2019-01-01",138 "incorporation_province_code": "O1"139 },140 "phone_numbers": [141 {142 "country_code": "27",143 "national_number": "3939249447",144 "type": "BUSINESS"145 }146 ],147 "beneficial_owners": {148 "individuals": [149 {150 "percentage_of_ownership": "25",151 "names": [152 {153 "type": "LEGAL",154 "given_name": "MaryAPPROVED",155 "surname": "Collins"156 }157 ],158 "citizenship": "ZA",159 "gender": "FEMALE",160 "primary_residence": {161 "address_line_1": "706 Ireland St",162 "admin_area_1": "Mkhuhlu",163 "admin_area_2": "Mpumalanga",164 "postal_code": "8301",165 "country_code": "ZA"166 },167 "tax_address": {168 "address_line_1": "1681 Glyn St",169 "admin_area_1": "Silverton",170 "admin_area_2": "Gauteng",171 "postal_code": "8301",172 "country_code": "ZA"173 },174 "addresses": [175 {176 "type": "HOME",177 "address_line_1": "Mkhuhlu",178 "admin_area_1": "Mkhuhlu",179 "admin_area_2": "Mpumalanga",180 "postal_code": "8301",181 "country_code": "ZA"182 }183 ],184 "birth_details": {185 "date_of_birth": "1960-01-01"186 },187 "identification_documents": [188 {189 "identification_number": "123456789",190 "issue_date": "2020-01-01",191 "expiry_date": "2025-01-01",192 "issuing_country_code": "ZA",193 "type": "PASSPORT"194 }195 ],196 "emails": [197 {198 "email": "test_account_admin@paypal.com"199 }200 ],201 "agreements": [202 {203 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",204 "accepted_time": "2019-06-02T01:23:45Z",205 "signature": "Mary Collins"206 }207 ],208 "declarations": [209 {210 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",211 "value": "YES"212 }213 ]214 }215 ],216 "office_bearers": [217 {218 "role": "CEO",219 "names": [220 {221 "type": "LEGAL",222 "given_name": "MaryAPPROVED",223 "surname": "Collins"224 }225 ],226 "citizenship": "ZA",227 "gender": "FEMALE",228 "primary_residence": {229 "address_line_1": "Mkhuhlu",230 "admin_area_1": "Mkhuhlu",231 "admin_area_2": "Mpumalanga",232 "postal_code": "8301",233 "country_code": "ZA"234 },235 "tax_address": {236 "address_line_1": "Silverton",237 "admin_area_1": "Silverton",238 "admin_area_2": "Gauteng",239 "postal_code": "8301",240 "country_code": "ZA"241 },242 "addresses": [243 {244 "type": "HOME",245 "address_line_1": "Mkhuhlu",246 "admin_area_1": "Mkhuhlu",247 "admin_area_2": "Mpumalanga",248 "postal_code": "8301",249 "country_code": "ZA"250 }251 ],252 "birth_details": {253 "date_of_birth": "1960-01-01"254 },255 "identification_documents": [256 {257 "identification_number": "123456789",258 "issue_date": "2020-01-01",259 "expiry_date": "2025-01-01",260 "issuing_country_code": "ZA",261 "type": "PASSPORT"262 }263 ],264 "emails": [265 {266 "email": "test_account_admin@paypal.com"267 }268 ],269 "agreements": [270 {271 "type": "FATCA_REPORTING_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",272 "accepted_time": "2019-06-02T01:23:45Z",273 "signature": "Mary Collins"274 }275 ]276 }277 ]278 }279 },280 "agreements": [281 {282 "type": "TERMS_ACCEPTED",283 "accepted_time": "2019-06-02T01:23:45Z"284 }285 ]286}