Test in sandbox

CurrentDocs

Last updated: Oct 18th, 5:30am

The happy path is the default state for testing verification in the sandbox. Because we can't run real verifications on test merchant data, PayPal's sandbox environment automatically passes the verification on your merchant accounts, and you can then test other features.

However, you can observe what happens when merchant accounts fail the electronic and manual verifications. Use simulation keywords to test verification failures in merchant accounts for the following scenarios:

  • Incorrect business information
  • Missing primary authorized user information
  • Incorrect primary authorized user information
  • Missing beneficial owner information
  • Incorrect beneficial owner name
  • Incorrect beneficial owner address
  • Incorrect business name and beneficial owner name
  • Incorrect beneficial owner address and primary authorized user information
  • Document accepted
  • Blurry document with wrong type
  • Wrong document type
  • Blurry document
  • Expired proof of identity
  • Missing document pages
  • Multiple document rejection reasons

Incorrect business information

Use case: Create a merchant account with incorrect business information.

Simulation code: The business_name must be DECLINED.

  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNMary",
13                    "surname": "Collins"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "Campus 611 - 1876",
18                "address_line_2": "West Seattle",
19                "admin_area_2": "Seattle",
20                "admin_area_1": "WA",
21                "postal_code": "98109",
22                "country_code": "US"
23            },
24            "birth_details": {
25                "date_of_birth": "1995-05-30"
26            },
27            "phone_numbers": [
28                {
29                    "country_code": "030",
30                    "national_number": "6151175",
31                    "extension_number": "1",
32                    "type": "MOBILE"
33                }
34            ],
35            "identification_documents": [
36                {
37                    "type": "SOCIAL_SECURITY_NUMBER",
38                    "identification_number": "050-64-9837",
39                    "issuing_country_code": "US"
40                }
41            ],
42            "emails": [
43                {
44                    "email": "add_email2@provider.com"
45                }
46            ],
47               "citizenship": "US"
48        
49        }
50    ],
51    "business_entity": {
52        "merchant_category_code": 5933,
53        "type": "CORPORATION",
54        "names": [
55            {
56                "type": "LEGAL",
57                "business_name": "DECLINED"
58            }
59        ],
60        "emails": [
61            {
62                "email": "email5@provider.com"
63            }
64        ],
65        "phone_numbers": [
66            {
67                "type": "BUSINESS",
68                "country_code": "1",
69                "national_number": "06151188"
70            }
71        ],
72        "website_info": {
73            "website_exists": true,
74            "website_url": "www.test.com"
75        },
76        "addresses": [
77            {
78                "address_line_1": "Campus 611 - 1876",
79                "address_line_2": "West Seattle",
80                "admin_area_2": "Seattle",
81                "admin_area_1": "WA",
82                "postal_code": "98109",
83                "country_code": "US",
84                "type": "BUSINESS"
85            }
86        ],
87        "identification_documents": [
88            {
89                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
90                "identification_number": "111222333",
91                "issuing_country_code": "US"
92            }
93        ],
94        "beneficial_owners": {
95            "individuals": [
96                {
97                    "percentage_of_ownership": "35",
98                    "names": [
99                        {
100                            "type": "LEGAL",
101                            "given_name": "Bill",
102                            "surname": "Smoth"
103                        }
104                    ],
105                    "citizenship": "US",
106                    "birth_details": {
107                        "date_of_birth": "1960-01-01"
108                    },
109                    "phone_numbers": [
110                        {
111                            "type": "WORK",
112                            "country_code": "1",
113                            "national_number": "061511"
114                        }
115                    ],
116                    "identification_documents": [
117                        {
118                            "type": "SOCIAL_SECURITY_NUMBER",
119                            "identification_number": "050-64-9837",
120                            "issuing_country_code": "US"
121                        }
122                    ],
123                    "emails": [
124                        {
125                            "email": "email5@provider.com"
126                        }
127                    ],
128                    "addresses": [
129                        {
130                            "address_line_1": "Campus 611 - 1876",
131                            "address_line_2": "West Seattle",
132                            "admin_area_2": "Seattle",
133                            "admin_area_1": "WA",
134                            "postal_code": "98109",
135                            "country_code": "US",
136                            "type": "HOME"
137                        }
138                    ]
139                }
140            ]
141        },
142        "office_bearers": [
143            {
144                "names": [
145                    {
146                        "given_name": "Another oneaa",
147                        "surname": "Collins",
148                        "id": "KCENS4XYWBBUW",
149                        "type": "LEGAL"
150                    }
151                ],
152                "identification_documents": [
153                    {
154                        "type": "SOCIAL_SECURITY_NUMBER",
155                        "identification_number": "243252871",
156                        "issuing_country_code": "US"
157                    }
158                ],
159                "addresses": [
160                    {
161                        "address_line_1": "Campus 611 - 1876",
162                        "address_line_2": "West Seattle",
163                        "admin_area_2": "Seattle",
164                        "admin_area_1": "WA",
165                        "postal_code": "98109",
166                        "country_code": "US",
167                        "type": "HOME"
168                    }
169                ],
170                "birth_details": {
171                    "date_of_birth": "1990-01-01"
172                },
173                "emails": [
174                    {
175                        "email": "email5@provider.com"
176                    }
177                ],
178                "phone_numbers": [
179                    {
180                        "type": "WORK",
181                        "country_code": "1",
182                        "national_number": "06151188"
183                    }
184                ],
185                "citizenship": "US"
186            }
187        ]
188    },
189    "agreements": [
190        {
191            "type": "TERMS_ACCEPTED",
192            "accepted_time": "2019-06-02T01:23:45Z"
193        }
194    ]
195}

Missing primary authorized user information

Use case: Create a merchant account with missing primary authorized user data, which prevents the merchant from transacting.

Simulation code: Use an API request to create an account with incompleteprimary authorized user information. In this example, our sole proprietor's address is missing.

  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNMarry",
13                    "surname": "Leo"
14                }
15            ],
16 
17            "birth_details": {
18                "date_of_birth": "1995-05-30"
19            },
20            "identification_documents": [
21                {
22                    "type": "SOCIAL_SECURITY_NUMBER",
23                    "identification_number": "050-64-9837",
24                    "issuing_country_code": "US"
25                }
26            ],
27            "phone_numbers": [
28                {
29                    "country_code": "030",
30                    "national_number": "6151175",
31                    "extension_number": "1",
32                    "type": "MOBILE"
33                }
34            ],
35            "emails": [
36                {
37                    "email": "add_email2@provider.com"
38                }
39            ],
40            "citizenship": "US"
41        }
42    ],
43    "business_entity": {
44        "merchant_category_code": 5933,
45        "type": "PROPRIETORSHIP",
46        "names": [
47            {
48                "type": "LEGAL",
49                "business_name": "Demo"
50            }
51        ],
52        "phone_numbers": [
53            {
54                "country_code": "{{phone_country_code}}",
55                "national_number": "{{phone_number}}",
56                "extension_number": "{{phone_country_code}}",
57                "type": "BUSINESS"
58            }
59        ],
60        "identification_documents": [
61            {
62                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
63                "identification_number": "111222333",
64                "issuing_country_code": "{{country_code}}"
65            }
66        ],
67        "emails": [
68            {
69                "email": "add_email2@provider.com"
70            }
71        ],
72        "website_info": {
73            "website_exists": false
74        }
75    },
76    "agreements": [
77        {
78            "type": "TERMS_ACCEPTED",
79            "accepted_time": "2019-06-02T01:23:45Z"
80        }
81    ]
82}

Incorrect primary authorized user information

Use case: Create a merchant account with an incorrect primary authorized user name that fails the electronic verification.

Simulation code:

  • The given_name for the primary authorized user ("individual_owners") name must include the word "DECLINED". For example, "LMTNDECLINED".
  • The surname for the primary authorized user ("individual_owners") must be "DECLINED".
  1. Sample Request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNDECLINED",
13                    "surname": "DECLINED"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "1234 Lane1 Drive",
18                "admin_area_2": "100",
19                "postal_code": "95014",
20                "country_code": "US"
21            },
22            "birth_details": {
23                "date_of_birth": "1995-05-30"
24            },
25            "phone_numbers": [
26                {
27                    "country_code": "030",
28                    "national_number": "6151175",
29                    "extension_number": "1",
30                    "type": "MOBILE"
31                }
32            ],
33            "emails": [
34                {
35                    "email": "add_email2@provider.com"
36                }
37            ],
38            "citizenship": "US"
39        }
40    ],
41    "business_entity": {
42        "merchant_category_code": 5933,
43        "type": "INDIVIDUAL",
44        "names": [
45            {
46                "type": "LEGAL",
47                "business_name": "Demo"
48            }
49        ],
50        "website_info": {
51            "website_exists": true,
52            "website_url": "www.test.com"
53        }
54    },
55    "agreements": [
56        {
57            "type": "TERMS_ACCEPTED",
58            "accepted_time": "2019-06-02T01:23:45Z"
59        }
60    ]
61}

Missing beneficial owner information

Use case: Create a merchant account with incomplete business owner data, which prevents the merchant from transacting.

Simulation code: Use an API request to create a merchant account with missing beneficial owner information. In this example, the beneficial owner is missing their SSN.

  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNMarry",
13                    "surname": "leo"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "1234 Lane1 Drive",
18                "admin_area_2": "100",
19                "postal_code": "95014",
20                "country_code": "US"
21            },
22            "birth_details": {
23                "date_of_birth": "1995-05-30"
24            },
25            "identification_documents": [
26                {
27                    "type": "SOCIAL_SECURITY_NUMBER",
28                    "identification_number": "243252871",
29                    "issuing_country_code": "US"
30                }
31            ],
32            "phone_numbers": [
33                {
34                    "country_code": "030",
35                    "national_number": "6151175",
36                    "extension_number": "1",
37                    "type": "MOBILE"
38                }
39            ],
40            "emails": [
41                {
42                    "email": "add_email2@provider.com"
43                }
44            ],
45            "citizenship": "US"
46        }
47    ],
48    "business_entity": {
49        "merchant_category_code": 5933,
50        "type": "ASSOCIATION",
51        "names": [
52            {
53                "type": "LEGAL",
54                "business_name": "DEMO"
55            }
56        ],
57        "emails": [
58            {
59                "email": "email5@provider.com"
60            }
61        ],
62        "phone_numbers": [
63            {
64                "type": "BUSINESS",
65                "country_code": "1",
66                "national_number": "06151188"
67            }
68        ],
69        "website_info": {
70            "website_exists": true,
71            "website_url": "www.test.com"
72        },
73        "addresses": [
74            {
75                "address_line_1": "Campus 611 - 1876",
76                "address_line_2": "West Seattle",
77                "admin_area_2": "Seattle",
78                "admin_area_1": "WA",
79                "postal_code": "98109",
80                "country_code": "US",
81                "type": "BUSINESS"
82            }
83        ],
84        "identification_documents": [
85            {
86                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
87                "identification_number": "111222333",
88                "issuing_country_code": "US"
89            }
90        ],
91        "beneficial_owners": {
92            "individuals": [
93                {
94                    "names": [
95                        {
96                            "given_name": "DECLINED",
97                            "surname": "DECLINED",
98                            "type": "LEGAL"
99                        }
100                    ],
101 
102                    "birth_details": {
103                        "date_of_birth": "1995-05-30"
104                    },
105                    "phone_numbers": [
106                        {
107                            "type": "WORK",
108                            "country_code": "1",
109                            "national_number": "06151188"
110                        }
111                    ],
112                    "addresses": [
113                        {
114                            "address_line_1": "Campus 611 - 1876",
115                            "address_line_2": "West Seattle",
116                            "admin_area_2": "Seattle",
117                            "admin_area_1": "WA",
118                            "postal_code": "98109",
119                            "country_code": "US",
120                            "type": "HOME"
121                        }
122                    ],
123                    "citizenship": "US",
124                    "percentage_of_ownership": "30"
125                }
126            ]
127        },
128        "office_bearers": [
129            {
130                "names": [
131                    {
132                        "given_name": "Another oneaa",
133                        "surname": "Collins",
134                        "type": "LEGAL"
135                    }
136                ],
137                "identification_documents": [
138                    {
139                        "type": "SOCIAL_SECURITY_NUMBER",
140                        "identification_number": "243252871",
141                        "issuing_country_code": "US"
142                    }
143                ],
144                "addresses": [
145                    {
146                        "address_line_1": "Campus 611 - 1876",
147                        "address_line_2": "West Seattle",
148                        "admin_area_2": "Seattle",
149                        "admin_area_1": "WA",
150                        "postal_code": "98109",
151                        "country_code": "US",
152                        "type": "HOME"
153                    }
154                ],
155          
156                "emails": [
157                    {
158                        "email": "email5@provider.com"
159                    }
160                ],
161                  "birth_details": {
162                        "date_of_birth": "1995-05-30"
163                    },
164                "phone_numbers": [
165                    {
166                        "type": "WORK",
167                        "country_code": "1",
168                        "national_number": "06151188"
169                    }
170                ],
171                "citizenship": "US"
172            }
173        ]
174    },
175    "agreements": [
176        {
177            "type": "TERMS_ACCEPTED",
178            "accepted_time": "2019-06-02T01:23:45Z"
179        }
180    ]
181}

Incorrect beneficial owner name

Use case: Create an account with an incorrect beneficial owner name that fails the electronic verification.

Simulation code: The "given_name" and "surname" for the beneficial owner (office_bearers or beneficial_owners) must be "DECLINED".

  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNMary",
13                    "surname": "Collins"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "Campus 611 - 1876",
18                "address_line_2": "West Seattle",
19                "admin_area_2": "Seattle",
20                "admin_area_1": "WA",
21                "postal_code": "98109",
22                "country_code": "US"
23            },
24            "birth_details": {
25                "date_of_birth": "1995-05-30"
26            },
27            "phone_numbers": [
28                {
29                    "country_code": "030",
30                    "national_number": "6151175",
31                    "extension_number": "1",
32                    "type": "MOBILE"
33                }
34            ],
35            "identification_documents": [
36                {
37                    "type": "SOCIAL_SECURITY_NUMBER",
38                    "identification_number": "050-64-9837",
39                    "issuing_country_code": "US"
40                }
41            ],
42            "emails": [
43                {
44                    "email": "add_email2@provider.com"
45                }
46            ],
47             "citizenship": "US"
48        
49        }
50    ],
51    "business_entity": {
52        "merchant_category_code": 5933,
53        "type": "CORPORATION",
54        "names": [
55            {
56                "type": "LEGAL",
57                "business_name": "DEMO"
58            }
59        ],
60        "emails": [
61            {
62                "email": "email5@provider.com"
63            }
64        ],
65        "phone_numbers": [
66            {
67                "type": "BUSINESS",
68                "country_code": "1",
69                "national_number": "06151188"
70            }
71        ],
72        "website_info": {
73            "website_exists": true,
74            "website_url": "www.test.com"
75        },
76        "addresses": [
77            {
78                "address_line_1": "Campus 611 - 1876",
79                "address_line_2": "West Seattle",
80                "admin_area_2": "Seattle",
81                "admin_area_1": "WA",
82                "postal_code": "98109",
83                "country_code": "US",
84                "type": "BUSINESS"
85            }
86        ],
87        "identification_documents": [
88            {
89                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
90                "identification_number": "111222333",
91                "issuing_country_code": "US"
92            }
93        ],
94        "beneficial_owners": {
95            "individuals": [
96                {
97                    "percentage_of_ownership": "35",
98                    "names": [
99                        {
100                            "type": "LEGAL",
101                            "given_name": "DECLINED",
102                            "surname": "DECLINED"
103                        }
104                    ],
105                    "birth_details": {
106                        "date_of_birth": "1960-01-01"
107                    },
108                    "phone_numbers": [
109                        {
110                            "type": "WORK",
111                            "country_code": "1",
112                            "national_number": "061511"
113                        }
114                    ],
115                    "identification_documents": [
116                        {
117                            "type": "SOCIAL_SECURITY_NUMBER",
118                            "identification_number": "050-64-9837",
119                            "issuing_country_code": "US"
120                        }
121                    ],
122                    "emails": [
123                        {
124                            "email": "email5@provider.com"
125                        }
126                    ],
127                     "citizenship": "US",
128                    "addresses": [
129                        {
130                            "address_line_1": "Campus 611 - 1876",
131                            "address_line_2": "West Seattle",
132                            "admin_area_2": "Seattle",
133                            "admin_area_1": "WA",
134                            "postal_code": "98109",
135                            "country_code": "US",
136                            "type": "HOME"
137                        }
138                    ]
139                }
140            ]
141        },
142        "office_bearers": [
143            {
144                "names": [
145                    {
146                        "given_name": "Another oneaa",
147                        "surname": "Collins",
148                        "id": "KCENS4XYWBBUW",
149                        "type": "LEGAL"
150                    }
151                ],
152                "identification_documents": [
153                    {
154                        "type": "SOCIAL_SECURITY_NUMBER",
155                        "identification_number": "243252871",
156                        "issuing_country_code": "US"
157                    }
158                ],
159                "addresses": [
160                    {
161                        "address_line_1": "Campus 611 - 1876",
162                        "address_line_2": "West Seattle",
163                        "admin_area_2": "Seattle",
164                        "admin_area_1": "WA",
165                        "postal_code": "98109",
166                        "country_code": "US",
167                        "type": "HOME"
168                    }
169                ],
170                "birth_details": {
171                    "date_of_birth": "1990-01-01"
172                },
173                "emails": [
174                    {
175                        "email": "email5@provider.com"
176                    }
177                ],
178                "phone_numbers": [
179                    {
180                        "type": "WORK",
181                        "country_code": "1",
182                        "national_number": "06151188"
183                    }
184                ],
185                "citizenship": "US"
186            }
187        ]
188    },
189    "agreements": [
190        {
191            "type": "TERMS_ACCEPTED",
192            "accepted_time": "2019-06-02T01:23:45Z"
193        }
194    ]
195}

Incorrect beneficial owner address

Use case: Create a merchant account with an incorrect beneficial owner or office bearer address that fails electronic verification.

Simulation code: For office_bearers or beneficial_owners:

  • address_line_1 must be Campus 611
  • address_line_2 must be 300
  • admin_area_2 must be 300
  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNMarry",
13                    "surname": "Leo"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "1234 Lane1 Drive",
18                "admin_area_2": "100",
19                "postal_code": "95014",
20                "country_code": "US"
21            },
22            "birth_details": {
23                "date_of_birth": "1995-05-30"
24            },
25            "identification_documents": [
26                {
27                    "type": "SOCIAL_SECURITY_NUMBER",
28                    "identification_number": "243252871",
29                    "issuing_country_code": "US"
30                }
31            ],
32            "phone_numbers": [
33                {
34                    "country_code": "030",
35                    "national_number": "6151175",
36                    "extension_number": "1",
37                    "type": "MOBILE"
38                }
39            ],
40            "emails": [
41                {
42                    "email": "add_email2@provider.com"
43                }
44            ],
45            "citizenship": "US"
46        }
47    ],
48    "business_entity": {
49        "merchant_category_code": 5933,
50        "type": "CORPORATION",
51        "names": [
52            {
53                "type": "LEGAL",
54                "business_name": "Demo"
55            }
56        ],
57        "emails": [
58            {
59                "email": "email5@provider.com"
60            }
61        ],
62        "phone_numbers": [
63            {
64                "type": "BUSINESS",
65                "country_code": "1",
66                "national_number": "06151188"
67            }
68        ],
69        "website_info": {
70            "website_exists": true,
71            "website_url": "www.test.com"
72        },
73        "addresses": [
74            {
75                "address_line_1": "Campus 611 - 1876",
76                "address_line_2": "West Seattle",
77                "admin_area_2": "Seattle",
78                "admin_area_1": "WA",
79                "postal_code": "98109",
80                "country_code": "US",
81                "type": "BUSINESS"
82            }
83        ],
84        "identification_documents": [
85            {
86                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
87                "identification_number": "111222333",
88                "issuing_country_code": "US"
89            }
90        ],
91        "beneficial_owners": {
92            "individuals": [
93                {
94                    "names": [
95                        {
96                            "given_name": "John",
97                            "surname": "Deo",
98                            "type": "LEGAL"
99                        }
100                    ],
101                    "emails": [
102                        {
103                            "email": "email5@provider.com"
104                        }
105                    ],
106                    "birth_details": {
107                        "date_of_birth": "1995-05-30"
108                    },
109                    "phone_numbers": [
110                        {
111                            "type": "WORK",
112                            "country_code": "1",
113                            "national_number": "06151188"
114                        }
115                    ],
116                    "addresses": [
117                        {
118                            "address_line_1": "Campus 611 - 1876",
119                            "address_line_2": "West settle",
120                            "admin_area_2": "marry",
121                            "admin_area_1": "WA",
122                            "postal_code": "98109",
123                            "country_code": "US",
124                            "type": "HOME"
125                        }
126                    ],
127                    "citizenship": "US",
128                    "percentage_of_ownership": "30"
129                }
130            ]
131        },
132        "office_bearers": [
133            {
134                "names": [
135                    {
136                        "given_name": "Marry",
137                        "surname": "cory",
138                        "type": "LEGAL"
139                    }
140                ],
141                "identification_documents": [
142                    {
143                        "type": "SOCIAL_SECURITY_NUMBER",
144                        "identification_number": "243252871",
145                        "issuing_country_code": "US"
146                    }
147                ],
148                "addresses": [
149                    {
150                        "address_line_1": "Campus 611",
151                        "address_line_2": "300",
152                        "admin_area_2": "300",
153                        "admin_area_1": "WA",
154                        "postal_code": "98109",
155                        "country_code": "US",
156                        "type": "HOME"
157                    }
158                ],
159                "birth_details": {
160                    "date_of_birth": "1990-01-01"
161                },
162                "emails": [
163                    {
164                        "email": "email5@provider.com"
165                    }
166                ],
167                "phone_numbers": [
168                    {
169                        "type": "WORK",
170                        "country_code": "1",
171                        "national_number": "06151188"
172                    }
173                ],
174                "citizenship": "US"
175            }
176        ]
177    },
178    "agreements": [
179        {
180            "type": "TERMS_ACCEPTED",
181            "accepted_time": "2019-06-02T01:23:45Z"
182        }
183    ]
184}

Incorrect business name and beneficial owner name

Use case: Create a merchant account with an incorrect business name and a beneficial owner name that fails electronic verification.

Simulation code:

  • The "business_name" must be "DECLINED".
  • The "given_name" and "surname" for the BO (office_bearers or beneficial_owners) must be "DECLINED".
  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNMarry",
13                    "surname": "Collins"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "1234 Lane1 Drive",
18                "admin_area_2": "100",
19                "postal_code": "95014",
20                "country_code": "US"
21            },
22            "birth_details": {
23                "date_of_birth": "1995-05-30"
24            },
25            "identification_documents": [
26                {
27                    "type": "SOCIAL_SECURITY_NUMBER",
28                    "identification_number": "243252871",
29                    "issuing_country_code": "US"
30                }
31            ],
32            "phone_numbers": [
33                {
34                    "country_code": "030",
35                    "national_number": "6151175",
36                    "extension_number": "1",
37                    "type": "MOBILE"
38                }
39            ],
40            "emails": [
41                {
42                    "email": "add_email2@provider.com"
43                }
44            ],
45            "citizenship": "US"
46        }
47    ],
48    "business_entity": {
49        "merchant_category_code": 5933,
50        "type": "PRIVATE_CORPORATION",
51        "names": [
52            {
53                "type": "LEGAL",
54                "business_name": "DECLINED"
55            }
56        ],
57        "emails": [
58            {
59                "email": "email5@provider.com"
60            }
61        ],
62        "phone_numbers": [
63            {
64                "type": "BUSINESS",
65                "country_code": "1",
66                "national_number": "06151188"
67            }
68        ],
69        "website_info": {
70            "website_exists": true,
71            "website_url": "www.test.com"
72        },
73        "addresses": [
74            {
75                "address_line_1": "Campus 611 - 1876",
76                "address_line_2": "West Seattle",
77                "admin_area_2": "Seattle",
78                "admin_area_1": "WA",
79                "postal_code": "98109",
80                "country_code": "US",
81                "type": "BUSINESS"
82            }
83        ],
84        "identification_documents": [
85            {
86                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
87                "identification_number": "111222333",
88                "issuing_country_code": "US"
89            }
90        ],
91        "beneficial_owners": {
92            "individuals": [
93                {
94                    "names": [
95                        {
96                            "given_name": "DECLINED",
97                            "surname": "DECLINED",
98                            "type": "LEGAL"
99                        }
100                    ],
101                    "citizenship": "US",
102                    "identification_documents": [
103                        {
104                            "type": "SOCIAL_SECURITY_NUMBER",
105                            "identification_number": "243252871",
106                            "issuing_country_code": "US"
107                        }
108                    ],
109                    "addresses": [
110                        {
111                            "address_line_1": "Campus 611 - 1876",
112                            "address_line_2": "West Seattle",
113                            "admin_area_2": "Seattle",
114                            "admin_area_1": "WA",
115                            "postal_code": "98109",
116                            "country_code": "US",
117                            "type": "HOME"
118                        }
119                    ],
120                    "birth_details": {
121                        "date_of_birth": "1990-01-01"
122                    },
123                    "emails": [
124                        {
125                            "email": "email5@provider.com"
126                        }
127                    ],
128                    "phone_numbers": [
129                        {
130                            "type": "WORK",
131                            "country_code": "1",
132                            "national_number": "06151188"
133                        }
134                    ],
135                    "percentage_of_ownership": "30"
136                }
137            ]
138        },
139        "office_bearers": [
140            {
141                "names": [
142                    {
143                        "given_name": "Another oneaa",
144                        "surname": "Collins",
145                        "type": "LEGAL"
146                    }
147                ],
148                "citizenship": "US",
149                "identification_documents": [
150                    {
151                        "type": "SOCIAL_SECURITY_NUMBER",
152                        "identification_number": "243252871",
153                        "issuing_country_code": "US"
154                    }
155                ],
156                "addresses": [
157                    {
158                        "address_line_1": "Campus 611 - 1876",
159                        "address_line_2": "West Seattle",
160                        "admin_area_2": "Seattle",
161                        "admin_area_1": "WA",
162                        "postal_code": "98109",
163                        "country_code": "US",
164                        "type": "HOME"
165                    }
166                ],
167                "birth_details": {
168                    "date_of_birth": "1990-01-01"
169                },
170                "emails": [
171                    {
172                        "email": "email5@provider.com"
173                    }
174                ],
175                "phone_numbers": [
176                    {
177                        "type": "WORK",
178                        "country_code": "1",
179                        "national_number": "06151188"
180                    }
181                ]
182            }
183        ]
184    },
185    "agreements": [
186        {
187            "type": "TERMS_ACCEPTED",
188            "accepted_time": "2019-06-02T01:23:45Z"
189        }
190    ]
191}

Incorrect beneficial owner address and primary authorized user information

Use Case: Create a merchant account with an incorrect beneficial owner address, incorrect primary authorized user information, and missing primary authorized user information.

Simulation code:

  • The "given_name" for the primary authorized user ( "individual_owners") must contain the word "DECLINED".
  • The "given_name" and "surname" for the beneficial owner("office_bearers" or "beneficial_owners") must be "DECLINED".
  • Do not include a required data point for a primary authorized user. In this example, we exclude the date of birth.
  1. Sample request
  2. Sample response
1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "LMTNDECLINED",
13                    "surname": "DECLINED"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "1234 Lane1 Drive",
18                "admin_area_2": "100",
19                "postal_code": "95014",
20                "country_code": "US"
21            },
22          
23            "identification_documents": [
24                {
25                    "type": "SOCIAL_SECURITY_NUMBER",
26                    "identification_number": "243252871",
27                    "issuing_country_code": "US"
28                }
29            ],
30            "phone_numbers": [
31                {
32                    "country_code": "030",
33                    "national_number": "6151175",
34                    "extension_number": "1",
35                    "type": "MOBILE"
36                }
37            ],
38            "emails": [
39                {
40                    "email": "add_email2@provider.com"
41                }
42            ],
43            "citizenship": "US"
44        }
45    ],
46    "business_entity": {
47        "merchant_category_code": 5933,
48        "type": "PRIVATE_CORPORATION",
49        "names": [
50            {
51                "type": "LEGAL",
52                "business_name": "DECLINED"
53            }
54        ],
55        "emails": [
56            {
57                "email": "email5@provider.com"
58            }
59        ],
60        "phone_numbers": [
61            {
62                "type": "BUSINESS",
63                "country_code": "1",
64                "national_number": "06151188"
65            }
66        ],
67        "website_info": {
68            "website_exists": true,
69            "website_url": "www.test.com"
70        },
71        "addresses": [
72            {
73                "address_line_1": "Campus 611 - 1876",
74                "address_line_2": "West Seattle",
75                "admin_area_2": "Seattle",
76                "admin_area_1": "WA",
77                "postal_code": "98109",
78                "country_code": "US",
79                "type": "BUSINESS"
80            }
81        ],
82        "identification_documents": [
83            {
84                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
85                "identification_number": "111222333",
86                "issuing_country_code": "US"
87            }
88        ],
89        "beneficial_owners": {
90            "individuals": [
91                {
92                    "names": [
93                        {
94                            "given_name": "DECLINED",
95                            "surname": "DECLINED",
96                            "type": "LEGAL"
97                        }
98                    ],
99                    "citizenship": "US",
100                    "identification_documents": [
101                        {
102                            "type": "SOCIAL_SECURITY_NUMBER",
103                            "identification_number": "243252871",
104                            "issuing_country_code": "US"
105                        }
106                    ],
107                    "addresses": [
108                        {
109                            "address_line_1": "Campus 611 - 1876",
110                            "address_line_2": "West Seattle",
111                            "admin_area_2": "Seattle",
112                            "admin_area_1": "WA",
113                            "postal_code": "98109",
114                            "country_code": "US",
115                            "type": "HOME"
116                        }
117                    ],
118                    "birth_details": {
119                        "date_of_birth": "1990-01-01"
120                    },
121                    "emails": [
122                        {
123                            "email": "email5@provider.com"
124                        }
125                    ],
126                    "phone_numbers": [
127                        {
128                            "type": "WORK",
129                            "country_code": "1",
130                            "national_number": "06151188"
131                        }
132                    ],
133                    "percentage_of_ownership": "30"
134                }
135            ]
136        },
137        "office_bearers": [
138            {
139                "names": [
140                    {
141                        "given_name": "Another oneaa",
142                        "surname": "Collins",
143                        "type": "LEGAL"
144                    }
145                ],
146                "citizenship": "US",
147                "identification_documents": [
148                    {
149                        "type": "SOCIAL_SECURITY_NUMBER",
150                        "identification_number": "243252871",
151                        "issuing_country_code": "US"
152                    }
153                ],
154                "addresses": [
155                    {
156                        "address_line_1": "Campus 611 - 1876",
157                        "address_line_2": "West Seattle",
158                        "admin_area_2": "Seattle",
159                        "admin_area_1": "WA",
160                        "postal_code": "98109",
161                        "country_code": "US",
162                        "type": "HOME"
163                    }
164                ],
165                "birth_details": {
166                    "date_of_birth": "1990-01-01"
167                },
168                "emails": [
169                    {
170                        "email": "email5@provider.com"
171                    }
172                ],
173                "phone_numbers": [
174                    {
175                        "type": "WORK",
176                        "country_code": "1",
177                        "national_number": "06151188"
178                    }
179                ]
180            }
181        ]
182    },
183    "agreements": [
184        {
185            "type": "TERMS_ACCEPTED",
186            "accepted_time": "2019-06-02T01:23:45Z"
187        }
188    ]
189}

Document accepted

Use case: Upload a document that PayPal approves.

Simulation code: The name of the document must include the word APPROVE. For example, passportAPPROVE.jpg

    1curl -v -X \
    2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
    3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
    4-H  "Authorization: Bearer Access-Token" \
    5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
    6-F 'driver_licence_front_and_back=@passportAPPROVE.jpg' \

    Blurry document

    Use case: Upload a document that is blurry and PayPal rejects it.

    Simulation code: The name of the document must be reject_R20.jpg.

      1curl -v -X \
      2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
      3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
      4-H  "Authorization: Bearer Access-Token" \
      5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
      6-F 'driver_licence_front_and_back=@reject_R20.jpg' \

      Blurry document with wrong type

      Use case: Upload a document that is blurry and of the wrong document type.

      Simulation code: The name of the document must be reject.jpg.

        1curl -v -X \
        2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
        3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
        4-H  "Authorization: Bearer Access-Token" \
        5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
        6-F 'driver_licence_front_and_back=@reject.jpg' \

        Wrong document type

        Use case: Upload a document of the wrong document type.

        Simulation code: The name of the document must be reject_R18.jpg.

          1curl -v -X \
          2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
          3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
          4-H  "Authorization: Bearer Access-Token" \
          5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
          6-F 'driver_licence_front_and_back=@reject_R18.jpg' \

          Expired proof of identity

          Use case: Upload a proof of identity document that is expired.

          Simulation code: The name of the document must be reject_R01.jpg.

            1curl -v -X \
            2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
            3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
            4-H  "Authorization: Bearer Access-Token" \
            5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
            6-F 'driver_licence_front_and_back=@reject_R01.jpg' \

            Missing document pages

            Use case: Upload a document where only one page of a two-page document is submitted.

            Simulation code:  The name of the document must be reject_R19.jpg.

              1curl -v -X \
              2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
              3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
              4-H  "Authorization: Bearer Access-Token" \
              5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
              6-F 'driver_licence_front_and_back=@reject_R19.jpg' \

              Multiple document rejection reasons

              Use case: Upload a document with multiple reasons for rejection, such as blurry and expired.

              Simulation code: To test multiple rejection reasons on a single document, include the reasons separated by an underscore (_). For example, name the file reject_R01_R20.jpg

                1curl -v -X \
                2POST https://api-m.sandbox.paypal.com/v1/customer/supporting-documents \
                3-H  "Content-Type: multipart/form-data; boundary=WebKitFormBoundarydCVmGbjc9rWllBlE" \
                4-H  "Authorization: Bearer Access-Token" \
                5-F 'input={"document_info": "{"document_type":"PASSPORT"}"};type=application/json' \
                6-F 'driver_licence_front_and_back=@reject_R01_R20.jpg' \
                ReferencePayPal.comPrivacyCookiesSupportLegalContact

                If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more