Introduction
This endpoint will provide you with the information required for each country to add an External Contact. Simply provide the 2 letter country code and the account type, BUSINESS or PERSONAL, and you will receive a JSON object listing all possible requirement categories and whether or not they are required for your particular case. Additionally you can provide optional parameter receiveMethod to specify requirements further.
Data Requirements
Provide the following data requirements when sending a GET request to the Required Data endpoint.
In the URL of your request include the following information as parameters.
| Parameter | Required? | Description | Type |
|---|---|---|---|
| country | Yes | This field is the two letter country code identifying the country that you want to retrieve information for. | String |
| accountType | Yes | This field indicates the account type for the contact you wish to add. This can be "BUSINESS" or "PERSONAL" as the requirements differ for each. | String |
| receiveMethod | No | This field indicates the receive method for the contact you wish to add. Possible values are BANK_ACCOUNT, PAYPAL, VENMO or CARD*. | String |
Note: Adding a card to a user through the API is a secure operation that adheres to strict encryption protocols and PCI compliance standards. To protect sensitive payment data, this process requires additional authentication steps, ensuring that all card information is handled safely and responsibly. Please contact your account manager to enable this functionality. Alternatively, cards may be created through the Link Widget by selecting the Debit Card option.