Sign in

v1

latestOpenAPI 3.0.02026-07-2691259477.2 KB
onboardings

If the account’s profile status is awaiting_information, start the onboarding flow. 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 (Id) provided in the response. 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.

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.

When you submit the payload, the API will:

• Identify the account and link the KYC process to it.

• All mandatory personal, contact, and address data for identity checks.

• Assesses AML/PEP risk via political exposure, financial profile, and source of funds.

• Verifies legal eligibility (age, capacity).

• Understands the user’s business intent (FAREWELL project) and downstream beneficiary.

• Redirects the user back to your specified redirectUrl once all steps succeed (or fail).

post/onboardings/individual

Request body

accountIdstring required

UUID of the previously created account

redirectUrlstring

URL to which the user will be redirected after completing onboarding

Example request

{
  "accountId": "ACC123456789",
  "redirectUrl": "https://www.lemonway.com/",
  "individual": {
    "firstName": "Jonathan",
    "lastName": "Doe",
    "otherName": "Smith",
    "birthDate": "1980-07-10",
    "birthCity": "Paris",
    "birthCountry": "FR",
    "birthProvince": "AG",
    "email": "jonathan.doe@gmail.com",
    "phoneNumber": "+33689222211",
    "address": {
      "street": "10 Via Roma",
      "city": "Milan",
      "postalCode": "20121",
      "country": "IT",
      "province": "AG"
    },
    "taxCode": "FR",
    "politicalExposure": {
      "status": "Yes",
      "position": "POLITICAL_LEADER",
      "startDate": "1980-07-10",
      "endDate": "2001-07-10",
      "fullName": "Michael James",
      "closeRelationship": "Child"
    },
    "financialSituation": {
      "annualRevenue": "0 - 10K €",
      "estimatedWealth": "0 - 50K €",
      "originOfFunds": {
        "other": "true"
      }
    },
    "legalCapacity": {
      "type": "Protected adult",
      "protectionType": "Family Guardianship"
    },
    "professionalSituation": {
      "activity": "85.31"
    }
  },
  "project": {
    "type": "WEDDING",
    "weddingRelation": "BRIDE_GROOM",
    "weddingPartnerFirstName": "Hector",
    "weddingPartnerLastName": "EMPEREUR"
  },
  "financialSupport": {
    "financialSituation": {
      "annualRevenue": "0 - 10K €",
      "estimatedWealth": "0 - 50K €",
      "originOfFunds": {
        "other": "true"
      }
    }
  }
}

Response

Onboarding session created successfully

idstring required
urlstring required

Example response

{
  "id": "ff928147-d51e-4f22-b26c-d2c1a2sebd8d",
  "url": "https://onboarding.sandbox.lemonway.com/d6795611-e957-457f-83fc-dd1c03775c08/welcome"
}