v1

latestOpenAPI 3.0.02026-07-2691259477.2 KB
onboardings

Initiates the online onboarding process for a legal entity whose profile status is AWAITING_INFORMATION. This call generates a secure onboarding session and returns a redirect URL where the end-user can complete their onboarding (e.g., KYC checks, document uploads).

post/onboardings/association

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/",
  "legalEntity": {
    "name": "Globex Corporation",
    "registrationNumber": "50JoRegistrationDOUBLON",
    "registrationDate": "2014-09-25",
    "vatNumber": "X9F7G8H2K1",
    "website": "alice.biz",
    "legalForm": "SAS",
    "address": {
      "street": "10 Via Roma",
      "city": "Milan",
      "postalCode": "20121",
      "country": "IT",
      "province": "AG"
    },
    "activity": {
      "NACEcode": "62.01Z",
      "ATECOcode": "62.01.00",
      "description": "Delivering cutting-edge payment solutions",
      "location": {
        "address": {
          "street": "10 Via Roma",
          "city": "Milan",
          "postalCode": "20121",
          "country": "IT",
          "province": "AG"
        }
      }
    }
  },
  "legalRepresentative": {
    "firstName": "Johns",
    "lastName": "Aimar",
    "birthDate": "1985-04-12",
    "birthCountry": "IT",
    "email": "claire.marchesi@example.com",
    "phoneNumber": "+336149568",
    "address": {
      "street": "10 Via Roma",
      "city": "Milan",
      "postalCode": "20121",
      "country": "IT",
      "province": "AG"
    },
    "politicalExposure": {
      "status": "Yes",
      "position": "POLITICAL_LEADER",
      "startDate": "1980-07-10",
      "endDate": "2001-07-10",
      "fullName": "Michael James",
      "closeRelationship": "Child"
    }
  }
}

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"
}