Individual Account Creation and Onboarding API Reference
Individual Endpoints
POST/accounts/individual
POST/onboardings/individual
GET/onboardings/{onboardingId}/resume
Account Creation Endpoint
POST/accounts/individual
Category: individual
Attribute | Required | Example | Data Type | Description |
---|---|---|---|---|
firstName | Yes | Johnathan | string | The first name of the individual. |
lastName | Yes | Lamary | string | The last name of the individual. |
birthDate | Yes | 1973-06-01 | date | The birth date of the individual, format: YYYY-MM-DD. |
Yes | regex | The email address of the individual. | ||
birthCountry | Yes | FR | enum | The country where the individual was born, two-letter country code (ISO-2). |
nationalities | Yes | FR, GB | string | The nationalities of the individual in two-letter country codes (ISO-2). |
country | Yes | FR | string | The country where the individual resides, two-letter country code. |
profile | Yes | PROJECT_HOLDER Other example profiles include: DONOR, INVESTOR, LENDER, BUYER, MERCHANT, CREDITOR, OPERATOR, CONTENT_EDITOR, OTHER_OPERATOR | enum | The profile type of the individual. Note: Only one profile will be permitted this is linked with the end-user's activity. |
walletId | Yes | f2470b35-4dd4-4fe1-bab2-f8c763ebcef5 | string | A unique identifier for the individual's wallet. |
{
"individual": {
"firstName": "Jonathan",
"lastName": "Lamary",
"birthDate": "1973-06-01",
"email": "[email protected]",
"address": {
"country": "FR"
},
"birthCountry": "FR",
"nationalities": [
"FR",
"GB"
]
},
"profile": "PROJECT_HOLDER",
"walletId": "{{$randomUUID}}",
}
Onboarding Endpoint
POST/onboardings/individual
Category: personal-information
To initiate the Online Onboarding process using the POST/onboardings/individual
endpoint, you need to submit the same data you used for account creation, along with the accountId
we provided.
All other data are optional to initiate an Online Onboarding and will be collected directly from the end-user, ensuring compliance with KYC requirements without additional data input from your side.
This information is on the first category of information required:
{
"accountId": "{{accountId}}",
"individual": {
"firstName": "Jonathan",
"lastName": "Lamary",
"birthDate": "1973-06-01",
"email": "[email protected]",
"address": {
"country": "FR"
},
"birthCountry": "FR",
"nationalities": [
"FR",
"GB"
]
},
}
Note
Some end-user personal information may be pre-filled when they open onboarding page for the first time, notably the name, email and contact details. We use the initial end-user data you sent us to inject into online onboarding page.
Required data set:
{
"accountId": "{{accountId}}",
"redirectUrl": "https://www.lemonway.com/",
"firstName": "Jonathan",
"lastName": "Lamary",
"birthDate": "1973-06-01",
"email": "[email protected]",
"birthCity": "Paris",
"birthCountry": "FR",
"phoneNumber": "+33675869559",
"nationalities": [
"FR"
],
"address": {
"street": "86017 Halle Loaf",
"city": "Aureliechester",
"postalCode": "311",
"province": "AO",
"country": "IT"
},
"politicalExposure": {
"status": "YES",
"position": "POLITICAL_LEADER",
"startDate": "1970-01-01"
},
"financialSituation": {
"annualRevenue": "FIRST_TIER",
"estimatedWealth": "FIRST_TIER",
"hasIFItax": true,
"taxCode": "HE23563769Y",
"originOfFunds": {
"sources": ["SAVINGS_ACCUMULATED_OVER_SEVERAL_YEARS"],
"other": "test"
}
},
"legalCapacity": {
"type": "LEGAL_AGE_AND_CAPACITY"
},
"professionalSituation": {
"activity": "69"
}
},
"project": {
"type": "FAREWELL",
"beneficiary": {
"firstName": "Jane",
"lastName": "Doe",
"birthDate": "1951-01-09"
}
}
}
Attribute | Required | Description | Data Type | Example |
---|---|---|---|---|
firstName | Yes | Official first name that appears on the user's legal documents, such as a passport. | string | Jonathan (not John) |
lastName | Yes | Official last name that appears on the user's legal documents. | string | Doe |
otherName | No | Maiden name/married name, used name, pseudo. | string | Smith |
birthDate | Yes | Format: YYYY-MM-DD | date | 1980-07-10 |
birthCity | Yes | City of birth | string | Paris |
birthProvince | Yes (for individuals born in Italy) | From a provided list | ||
birthCountry | Yes | ISO-2 format | string | FR |
nationalities | Yes | ISO-2 format. Allows multiple nationalities. | string | FR, GB |
Yes | regex | |||
phoneNumber | Yes | Must include country code. | regex | +33689222211 |
street | Yes | string | 44 Rue de l'Abbaye | |
complementaryStreetInfo | No | string | Batiment A | |
city | Yes | string | Paris | |
postalCode | Yes | string | 75000 | |
province | Yes (for individuals living in Italy) | From a provided list | ||
residenceCountry | Yes | ISO-2 format | iso-alpha2 | FR |
taxCode | Yes (for individuals born or living in Italy) | Specific tax code format | string | MRTMTT91D08F205J |
status (Are you a politically exposed person?) | Yes | Politically exposed person status: enum { no, yes, close } | enum | Yes |
position | Yes (if status is "YES") | There are 9 identified positions and one option to state another position if it does not appear on the list. enum: { POLITICAL_LEADER, POLITICAL_REPRESENTATIVE, JUDICIAL_OFFICIAL, FINANCIAL_AUDITOR, BANK_EXECUTIVE, DIPLOMATIC_REPRESENTATIVE, MILITARY_LEADER, ADMINISTRATIVE_OFFICIAL, ORGANIZATIONAL_OFFICIAL, OTHER} | enum | POLITICAL_LEADER |
otherPosition | Yes (if position is "OTHER") | 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 | string |
startDate | Yes (if status is "YES" or "CLOSE") | Format: YYYY-MM-DD | date | 1980-07-10 |
endDate | Optional | Format: YYYY-MM-DD. If unknown, not required. | date | 2001-07-10 |
closeRelationship | Yes (if status is "CLOSE") | Options include: Child, Parent, Spouse (wife or husband) enum: { PARTNER, CHILD, PARENT } | enum | Child |
fullName | Yes (if status is "CLOSE") | Full legal name of the politically exposed person | string | Michael James |
professionalSituation | Yes | There are 3 broad categories, they are not an exhaustive list of professions, but offer the most common occupations:
| enum | 85.31 |
annualRevenue | Yes | This revenues are listed in a 6 tiers format. enum: { FIRST_TIER, SECOND_TIER, THIRD_TIER, FOURTH_TIER, FIFTH_TIER, SIXTH_TIER } { 0 - 10K | enum | 0 - 10K € |
estimatedWealth | Yes | 7 tiers to select from. enum: { FIRST_TIER, SECOND_TIER, THIRD_TIER, FOURTH_TIER, FIFTH_TIER, SIXTH_TIER, SEVENTH_TIER } { 0 - 50K € | enum | 0 - 50K € |
hasIFITax | Yes (only for French residents) | Boolean statement | boolean | true |
originOfFunds.sources | Yes (for investors only) | enum: {INCOME, REAL_ESTATE_PROPERTIES, SAVINGS_ACCUMULATED_OVER_SEVERAL_YEARS, DONATION_OR_INHERITANCE, SALE_OF_A_STOCK_PORTFOLIO, TRANSFER_OF_COMPANY_SHARES, WINNING_FROM_GAMES_OR_CONTESTS, SURRENDER_OF_A_CAPITALIZATION_CONTRACT_OR_LIFE_INSURANCE_POLICY, SALE_OF_MOVABLE_ASSETS_GOODWILL_INTELLECTUAL_PROPERTY_RIGHTS, SALE_OF_CURRENCY_GOLD_OR_CRYPTOCURRENCIES, FINANCIAL_INVESTMENTS, OTHER_OPERATIONS} | enum | Income (salary, etc.) |
originOfFunds.other | Required if origin is "OTHER_OPERATIONS" | Description of other origin of funds | string | |
type | Yes | The end-user is required to state their legal capacity. There are 4 options:
| enum | Protected adult |
protectionType | Yes (if type is "Protected adult") | Enum of protection types | enum | Family Guardianship |
otherProtectionType | Yes (if protection type is "OTHER") | Must specify other protection type | string |
Project-Specific Attributes (For Project Holder Profile):
Attribute | Required | Description | Data Type | Example |
---|---|---|---|---|
projectType | Yes | The attribute allows the end-user to specify the type of the project they are collection funds for, there are 6 categories. enum: { WEDDING, FAREWELL, NEW_BORN, BIRTHDAY, CHARITY, OTHER } | enum | Wedding |
website | Yes | URL of the fund | string | |
description | Yes | Description of fund usage | string | |
weddingRelationType | Yes (if type is "Wedding") | enum: {BRIDE_GROOM, OTHER} | enum | Managing pot for groom and bride |
beneficiaryFirstName | Yes (if type is "Wedding") | The first name of the person who is receiving the funds, gift or service. | string | Matthew |
beneficiaryLastName | Yes (if type is "Wedding") | The last name of the person who is receiving the funds, gift or service. | string | Riley |
beneficiaryBirthDate | Yes (if type is "Wedding") | The date of birth of the person who is receiving the funds, gift or service | date | 1970-01-01 |
Category: resume:
The resume object is called when an end-user decides to save their progress and return to the onboarding page at a later date.
GET /onboardings/{onboardingId}/resume
The accountId is required in the path parameter to retrieve the end-user's onboarding page.
Updated 9 days ago