Relation status definition

The relationState represents the overall, current state of the relationship between a user and Xpollens.

A status describes a functional state of the relationship.

reasons may be associated with a status to clarify its cause, without artificially multiplying the number of statuses.

The relationship status is orthogonal to onboarding or account statuses: it aggregates them and goes beyond them.

A user has one and only one active relationship status at any given time.

State diagram

stateDiagram
[*] --> Initialized: User created
Initialized --> AwaitingInactivation : 
Initialized --> InProgress : onboarding ongoing
InProgress --> Initialized : digital score reset
InProgress --> AwaitingInactivation: onboarding refused
InProgress --> Active: onboarding completed
Active --> AwaitingInactivation: User closure <br/> waiting for account closure
Active --> Inactive: NoActiveAccounts use case
AwaitingInactivation --> Inactive: User closed
Inactive --> [*]

Transition	reasons
Initialized --> AwaitingInactivation	Onboarding refused because the user is on a blacklist the digital scoring is refused (NotCompliant) the enduser did not complete a step and kycTimedOut
InProgress --> Initialised	An updated occurs on the personal data. The digital scoring is reset.
InProgress --> AwaitingInactivation	Onboarding refused: KycNotValidated KycTimedOut KycFraudDetected NotCompliant KycKoReopeningLimitReached
Active --> AwaitingInactivation	A user-initiated or regulatory action has led to a request for closure or termination of the relationship, which is still being processed. For example: account closure, periodic review not performed
Active --> Inactive	NoActiveAccounts

📘
When the relationState.status = Inactive, the user is fully closed. This action is irreversible.

relationState & use cases

Onboarding failed

The relationState.status can change to “Inactive” for several reasons:

Xpollens refuses the commercial relationship: the end user has a poor digital score, is listed on sanctions lists, etc.
The end user fails to complete their KYC: within the required timeframe, due to data quality issues, etc.
The end user fails to complete other onboarding steps: FATCA declaration, acceptance of terms and conditions, etc.

reasons	status	Description
Sanctionned	AwaitingInactivation	User is listed on sanctions lists.
PEPRiskDeclined	AwaitingInactivation	User politically exposed person, and Xpollens refuses the commercial relationship.
TermOfUseRefused	AwaitingInactivation	Terms & conditions are refused by the enduser.
KycFraudConfirmed	AwaitingInactivation	KYC fraud detected during the onboarding.
KycReopeningLimitReached	AwaitingInactivation	The end user attempted to complete their KYC too many times (>5)
KycValidationFailed	AwaitingInactivation	KYC refused (& not fraud)
NotCompliant	Inactive	Digital scoring KO
AccountFraudConfirmed	AwaitingInactivation	Fraud detected during the commercial relationship
KycTimedOut	AwaitingInactivation or Inactive	The KYC expired after 90 days.

For professional user

reasons	status	Description
MandatedNotValidated	AwaitingInactivation	Mandated not validated
AtLeastOneBeneficialOwnerNotValidated	AwaitingInactivation	One or multiple beneficial owners not validated
AtLeastOneLegalRepresentativeNotValidated	AwaitingInactivation	One or multiple legal representatives not validated

Periodic review

Periodically, endusers have to update their data. If a enduser does not respect this reglementary requirement, their account is closed, and the RelationStatus changes for "Inactive"

reasons	status	Description
PeriodicReviewTimedOut	Inactive	Periodic review not performed in time

End of commercial relationship

As soon as the commercial relationship ends, the RelationStatuschanges for "Inactive".

Closure at the initiative of Xpollens

reasons	status	Description
TermOfUseRefused	AwaitingInactivation	User refused to sign terms ans conditions
AccountFraudConfirmed	AwaitingInactivation	Fraud
NotCompliant	AwaitingInactivation	User does not respect terms and conditions

Closure at the initiative of the enduser.

The commercial relationship is considered as ended as soon as all user's account are closed.

This termination may result from the end user’s decision to close their account, whether the request is made to you or to Xpollens.

reasons	status	Description
NoActiveAccounts	AwaitingInactivation	User closed all their accounts.

Email reuse

The email address can be reused if:

the user is closed because the KYC was not completed in time
the user is closed because the periodic review was not completed in time

🚧
For now, the email address cannot be reused when a user is deactivated because all of their accounts are closed NoActiveAccounts

🚧
If five KYC attempts fail, the email address is considered “used up” and cannot be reused.

🚧
For any other reason, the email address cannot be reused.

Technical items

Webhook UserCreatedOrUpdated

https://docs.xpollens.com/reference/post_usercreatedorupdated

API

https://docs.xpollens.com/reference/user_getusersbycriteriaid_get

How to test

According to the use case, refer to the section "How to test" in the dedicated documentation.