post https://prod.api.getborderless.com/accounts
Introduction
This endpoint is used to create an account via the borderless™ API. This is a POST request that takes in body parameters noted below. These vary per country so please use the required information endpoint to confirm what data is required for your specific Account's country.
Data Requirements
Provide the following data requirements when sending a POST request to the Accounts endpoint.
Additional Header parameter:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| Client-Id | No | Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. | String |
The body of this request can contain the following parameters:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| Yes | The email address of the child account holder. | String | |
| emailVerified | Yes | This field identifies if email of child account is verified. Must be true for successful account creation. | Boolean |
| acceptTermsAndConditions | Yes | This field identifies that account owner accepts terms and conditions of borderless™. Must be true for successful account creation. | Boolean |
| accountType | Yes | Child account account type. Possible values are BUSINESS or PERSONAL. | String |
| country | Yes | The two letter ISO code for the child account country (must match with the bank account you will add). You can retrieve borderless™ supported countries via Reference Section of the API. | String |
| currency | Yes | The primary three letter currency code of the account (must match with your bank account currency). You can retrieve borderless™ supported currencies via Reference Section of the API. | String |
| firstName | Yes | First name of the child account owner (must match with the bank account you will add). | String |
| middleName | No | Middle name of the child account owner. | String |
| lastName | Yes | Last name of the child account owner (must match with the bank account you will add). | String |
| phoneNumber | No | Phone number of child account owner. Phone number format must contain only numbers and must be submitted without country code. For example if phone number for United States account is +1 (123)-456-7890 you should submit 1234567890. Check requirements according country and account type to confirm if this field is required. | Number |
| dateOfBirth | Yes | Date of birth of child account owner. The format of this field should be YYYY-MM-DD. | String |
| handle | No | The unique identifier for account. You can specify your own or it will be generated automatically and provided for you in response of successful account creation. | String |
| addressLine1 | Yes | The address of the child account. | String |
| addressLine2 | No | The address of the child account. | String |
| city | Yes | The city of the child account. | String |
| zoneCode | Yes | Zone codes for your desired country. You can retrieve zone codes via Reference Section of the Payout API | String |
| postalCode | Yes | Postal code of the address. If country does not have postal codes system, simply submit 00000. | String |
| Citizenship | No | The two letter ISO code of country of citizenship. This field is required for AU country. | String |
| placeOfBirthCountry | No | The two letter ISO code of place of birth. This field is required for few of the countries. One of them is IN. | String |
| placeOfBirthRegion | No | The zone code of place of birth country. This field is required for few of the countries. One of them is IN. | String |
| personalTaxId | No | A taxpayer identification number. | String |
| businessName | No | The name of the business. For BUSINESS type account this field is required. | String |
| displayName | No | The display name that will be shown on borderless™ dashboard. If not specified display name will be auto-generated according business name for BUSINESS accounts and according first and last names for PERSONAL accounts. | String |
| jobTitle | No | A formal name for a specific position within an organization. To retrieve all possible job titles for this field please visit Reference Section. | String |
| businessType | No | Type of the business. To retrieve all possible business types for specific country please visit Reference Section. | String |
| businessTaxId | No | A corporate tax identification number. For BUSINESS type account this field is required. | String |
| industry | No | The industry of the business. For BUSINESS type account this field is required. To retrieve all possible business industries for this field please visit Reference Section. | String |
| businessSize | No | Non-negative number of aproximate number of employees. | Number |
| estimatedMonthlyVolume | No | Non-negative number of aproximate monthly volume. | Number |
| estimatedMonthlyTransactions | No | Non-negative number of aproximate monthly transactions. | Number |
| bankDataRequired.accountNumber | Yes | The number associated with the bank account you want to add. | String |
| bankDataRequired.bankName | Yes | The name of the bank for the account you want to add. | String |
| bankDataRequired.bankAccountType | Yes | The type of bank account you want to add. Possible values are: CHECKING | SAVINGS. | String |
| bankDataRequired.routingNumber | Yes/No | The routing number used by the bank account if applicable. | String |
| bankDataRequired.bankSwiftBic | Yes/No | The SWIFTBIC identifier used by the bank account if applicable. | String |
| bankDataRequired.branchName | Yes/No | The name of the individual branch for th bank account you wish to add if applicable. | String |
| bankDataRequired.country | Yes | The two letter ISO code for bank account country. Must match with account country. | String |
| bankDataRequired.currency | Yes | The primary three letter currency code of the bank account. Must match with account currency. | String |