KYC status processing

The KYC process starts after creating the user in Hyperwallet. Hyperwallet gets in contact with the seller through the shop’s contact information in Mirakl.

The KYC status processing isn’t started by the connector using jobs. Hyperwallet servers are the ones notifying the progress of the KYC verification to the connector. The connector then updates the KYC status in Mirakl.

Characteristics

  • The connector makes uses of the webhooks functionality provided by Hyperwallet.

  • The connector updates the KYC status in Mirakl which is visible in the Mirakl backoffice for the sellers.

KYC status processing process

kyc-process

Hyperwallet events

The connector processes the following events associated to Hyperwallet’s user type:

Event Relevant fields

USERS.UPDATED.VERIFICATION_STATUS.*

  • token

  • type

  • createdOn

  • object.token

  • object.clientUserId

  • object.verificationStatus

Hyperwallet documentation provides more information about the Hyperwallet user events.

API calls

The connector does the following API calls during the sellers extraction jobs execution:

Call Target System Endpoint Parameters

Update KYC status of a shop

Mirakl

S07 - Patch shop

  • shop_id: shop identifier

  • kyc.status: KYC status for the shop calculated as explained in the data mapping section.

  • kyc.reason: descriptive message associated to the KYC status displayed in the Mirakl back office.

Data mapping

Based on the verificationStatus field of Hyperwallet’s user updated event, the connector does the following mapping into Mirakl KYC status:

Hyperwallet verification status Mirakl KYC status

UNDER_REVIEW

Awaiting KYC verification (PENDING_APPROVAL)

VERIFIED

KYC Passed (APPROVED)

REQUIRED

Awaiting KYC data (REFUSED)

NOT REQUIRED

KYC Passed (Approved)