Resource Account Creation
Object: individual:
| Attribute | Required | Description | Example |
|---|---|---|---|
| firstName | Yes | The first name of the individual. | Johnathan |
| lastName | Yes | The last name of the individual. | Lamary |
| birthDate | Yes | The birth date of the individual, format: YYYY-MM-DD. | 1973-06-01 |
| Yes | The email address of the individual. | JLamry55@gmail.com | |
| birthCity | Yes | The city where the individual was born. | Paris |
| birthCountry | Yes | The country where the individual was born, two-letter country code. | FR |
| phoneNumber | Yes | The phone number of the individual, including country code. | +33675869559 |
| nationalities | Yes | The nationalities of the individual in two-letter country codes. | FR, GB |
| street | Yes | The street name of the individual's residence. | 24 rue des peupliers |
| complementaryStreetInfo | Optional | Additional street information if applicable. | bis |
| postalCode | Yes | The postal code for the individual's residence. | 92130 |
| city | Yes | The city where the individual resides. | Issy |
| residenceCountry | Yes | The country where the individual resides, two-letter country code. | FR |
| profile | Yes | The profile type of the individual. | PROJECT_HOLDER |
| walletId | Yes | A unique identifier for the individual's wallet. | f2470b35-4dd4-4fe1-bab2-f8c763ebcef5 |
| solutionName | Yes | The name of the payment or wallet solution being used. | lemonway |
Resource Onboarding
Object: personal-information:
This information is in the first category of information required on the onboarding form:
Note: Some end-user personal information may be prefilled when they open the onboarding form for the first time, notably the name, email, and contact details. We use the initial end-user data you sent us to inject into the onboarding form.
| Attribute | Required | Description | Example |
|---|---|---|---|
| firstName | Yes | Official first name that appears on the user's legal documents. The name that appears on a passport. | Michael (not Mike) |
| lastName | Yes | Official last name that appears on the user's legal documents. | Jenkins |
| otherName | No | Maiden name/married name, use name, pseudo. | - |
| birthDate | Yes | DD/MM/YYYY | 18/07/1980 |
| birthCity | Yes | City of birth | Paris |
| birthCountry | Yes | Country of birth. This should be in ISO-2 format, for example: FR for France. | France |
| nationalities | Yes | The onboarding form allows you to add multiple nationalities. | French, German |
Object: Contact-address:
| Attribute | Required | Example |
|---|---|---|
| phoneNumber | Yes | 06 89 22 22 11 Note: Country code not required as the user selects the country code from the provided list. |
| street | Yes | 44 Rue de l'Abbaye |
| complementaryStreetInfo | No | - |
| city | Yes | Paris |
| postalCode | Yes | 75000 |
| residenceCountry | Yes | France |
| Yes | JackFarmer18@gmail.com | |
| taxcode | Yes Note: Required for Italian residents |
AB565657 |
Object: political-exposure:
| Attribute | Required | Description | Example |
|---|---|---|---|
| status (Are you a politically exposed person?) | Yes | There are 3 options: 1. Yes 2. No 3. Close to a politically exposed person |
Yes |
| position | Yes | There are 9 identified positions and one option to state another position if it does not appear on the list. You have to specify the political position if it does not appear on the provided list. Political Leader, Political Representative, Judicial Official, Financial Auditor, Bank Executive, Diplomatic Representative, Military Leader, Administrative Official, Organizational Official |
Political Leader |
| startDate | Yes | This should correspond to the first day in the person's position using the following format: DD/MM/YYYY | 10/07/2020 |
| endDate | Optional | This should correspond to the last day in the person's position using the following format: DD/MM/YYYY. However, if this date is unknown, the person does not need to specify. | 10/10/2022 |
| otherPosition | Yes | This option is selected if the person's job title does not appear in the provided list. The person must state their official position. | string |
| closeRelationship | Yes | If a person is related or has a relationship to a politically exposed individual, they must state their relationship. Options include: Child, Parent, Spouse (wife or husband) | Child |
| fullName | Yes | The full legal name of the politically exposed person must be specified. | Michael James |
Object: financial-situation:
| Attribute | Required | Description | Example |
|---|---|---|---|
| annualRevenue | Yes | The revenues are listed in a 6-tier format: Below 10K 10K - 25K ... ... up to over 100K Note: All listings are in Euro. |
51K - 75K |
| estimatedWealth | Yes | 7 tiers to select from: Below 50K to over 1 million euros Note: All listings are in Euro. |
101K - 150K |
| hasIFItax | Yes | This is a true or false statement that validates that the end user is subject to wealth tax. Only for French residents |
Yes - validating that you are subject to wealth tax |
Object: legal-capacity:
PUT /onboardings/{id}/legal-capacity
| Attribute | Required | Description | Example |
|---|---|---|---|
| Type | Yes | The end-user is required to state their legal capacity. There are 2 options: 1. Of legal age and capacity 2. Protected adult |
Protected adult |
| if Minor | Yes | If end-user is a minor, we will ask: Type = 1. Non-emancipated minor 2. Emancipated minor |
Emancipated minor |
| ProtectionType | Yes | If the end-user selects Protected adult, they are required to specify the type of protection they are under. Options are: 1. Safeguarding of Justice 2. Curatorship 3. Guardianship 4. Other (must specify) Note: Full details of protection types are explained on the official French government website here (French only) |
Guardianship |
| OtherProtectionType | Yes | Other type of protection (must specify) | - |
Object: professional-situation:
PUT /onboardings/{id}/professional-situation
This area in the onboarding form is displayed in 3 broad categories. These categories are not exhaustive lists of professions, but they offer the most common occupations. The end-user has the ability to select Other in a category to specify a unique or a profession not listed:
- Professional activity - example: teacher, IT manager
- Non-professional activity - example: student, unemployed
- Retired
Note: There are over 75 categories, and therefore they have not been listed here. This is also a required part of the onboarding form.
Object: project:
PUT /onboardings/{id}/project
| Attribute | Required | Description | Example |
|---|---|---|---|
| Type (Your project) | Yes | The attribute allows the end-user to specify the type of project they are collecting funds for. There are 6 categories: 1. Wedding 2. Farewell 3. New Born 4. Birthday 5. Charity 6. Other Note: Depending on the user's selection, different details will be required. |
Wedding |
| Beneficiary | Yes | For transparency reasons, the end-user must state the beneficiary's first and last name. | Shelly Thomas |
| Website | Yes | URL to the fund | www.shellywedding.co |
| Description | Yes | A description of what the funds are going to be used for. | |
| Wedding Relation (Only displayed when wedding is selected) | Yes | This option lets the end-user identify who they are in the project. The options are: 1. I am the groom/bride 2. I manage the money pot for the groom and bride |
I manage the money pot for the groom and bride |
| WeddingPartnerFirstName (Receipt of fund, Only displayed when wedding is selected) | Yes | This display is dependent on the former selection. If the end-user has selected I am the groom/bride, they will have to state their partner's first name. Otherwise, they will have to state the fund's receipt first name. | Matthew |
| WeddingPartnerLastNameReceipt of fund (Only displayed when wedding is selected) | Yes | This display is dependent on the former selection. If the end-user selects I am the groom/bride, they will have to state their partner's last name. Otherwise, they will have to state the fund's receipt last name. | Riley |
Important: If the end-user selects a farewell, newborn, or birthday project type, they must withdraw the money to one of their bank accounts for legal and transparency reasons.
Note: If the end-user selects a charity project, they must add the URL to the charity and state the reasons for the project.
Object: resume
The resume object is called when an end-user decides to save their progress and return to the onboarding form at a later date.
GET /onboardings/{accountId}/resume
The accountId is required in the path parameter to retrieve the end-user's onboarding form.