Online Onboarding Webhooks

Webhook Notifications Overview

Webhook notifications provide updates on key events related to account creation and onboarding progress. Below is a summary of the key notification types, implementation guidelines, and best practices.

Notification Types

1. Account Creation & Status Updates

Receive updates when an account is created or its status changes. Only when an account status is "Accepted" is a wallet created.

Webhook Event ID: 50
Status values:

Notification Status	Account Status	Status Trigger	Objective of the Status
1	`CREATED`	Callback after POST `/account` for a User and a Business relationship	The end-user's account has been successfully created.
2	`ACCEPTED`	N/A	The end-user account has been approved and a wallet has been opened. The onboarding process is now complete.
3	`DENIED`	Regulatory reason	We have declined the activation of the end-user's account, and a wallet will not be opened. The onboarding process is now complete.
4	`BLOCKED`	Entity blocked for regulatory reason or KYC update outdated	End-user is unable to access wallet, the account is blocked.
5	`KYC_UPDATE_REQUESTED`	The next verification date is approaching, and the end-user must review their information.	In most cases, the end-user will simply need to confirm the existing details. However, in some situations, they may be required to submit an additional document or complete the identity verification process (e.g., liveness check). In any case, this does not require any action from you, as Lemonway handles the entire process. The only impact is on the Online Onboarding workflow, where it may affect the generated form.
6	`KYC_UPDATE_REJECTED`		As with the Online Onboarding process, Lemonway may need to request additional information based on the end-user’s responses or if the submitted document(s) are rejected.
7	`KYC_UPDATE_ACCEPTED`	End of Process	The KYC update has been validated by Lemonway’s analysts, allowing the end-user to continue their activity on the partner’s website.

Payload Example:

{
  "EventDate": "2015-11-01T16:44:55.883",
  "AccountID": "37373",
  "ProfileID": "93843",
  "IntId": "32",
  "ExtId": "jdkc",
  "Status": "2"
}

2. Onboarding Progress Updates (Profile Status)

Track an end-users onboarding journey through changes in profile status.

Webhook Event ID: 49

Status Values:

Notification Status	Profile Status	Status Trigger	Objective of the Status
1	`CREATION_IN_PROGRESS`	Callback after POST `/account` for an individual user	Onboarding is not required.
1	`AWAITING_INFORMATION`	Callback after POST `/account` for a Business Relationship	Additional data and documents must be collected via an onboarding form.
2	`UNDER_ANALYSIS`	Updated when onboarding is submitted.	The end-user has submitted the online onboarding. Lemonway’s analysts will now assess the information and decide whether to approve the account.
3	`ACCEPTED`	Lemonway sends if an `account status` = `accepted`	Lemonway has accepted the entry into relationship. Account status switches to `accepted` and onboarding is over.
4	`DENIED`	Lemonway sends if an `account status` = `denied`	Lemonway has denied the entry into relationship. Account status switches to `denied` and onboarding is over.
5	`REJECTED`	Lemonway returns `account status` = `rejected` with one of the following reasons: Regulatory requirements not met. Onboarding request rejected. Onboarding process incomplete.	To finalise the onboarding process, we require further information from the end-user.

Payload Example:

{
  "EventDate": "2015-11-01T16:44:55.883",
  "AccountID": "37373",
  "ProfileID": "454545",
  "IntId": "32",
  "ExtId": "jdkc",
  "Status": "2"
}

Description

Key	Description
EventDate	Date and time the notification was created. Paris time. Format ISO8601
accountID	ID of the account
profileID	List of profileID linked to this account
ExtId	External ID of the wallet
IntId	Internal ID of the wallet (if any)
Status	Account status

👍
Info
An account status is updated upon completion of KYC checks. Depending on whether controls are automatic or manual, results may take from a few minutes up to a maximum of 48 hours.

📘
Note
Webhook notifications can be delayed by up to one hour. We recommend performing a GET request after receiving a webhook to retrieve the latest information.

Implementation Steps

Set Up Webhooks
Configure webhook endpoints to receive notifications for both account and profile status changes.
Handle Notifications
Implement logic to process different notification types and update your systems accordingly.
Monitor Status Continuously
Regularly check account and profile statuses to ensure onboarding is progressing as expected.