The IDV Session object
Description
Mangopay relies on the IDV Session object to provide its hosted KYC/KYB verification solution. The object contains the unique session URL for the hosted frontend experience where the user can provide all the necessary data and documents for verification. Read more →
Attributes
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The status of the overall IDV Session:
PENDING– Session created. TheHostedUrlis valid for completion, regardless of whether the user has started or submitted the session.REVIEW– One or more automated checks was neither successful nor refused, so the session was sent for manual review by Mangopay's teams. This temporary state is only applicable to Legal users and can transition toREFUSEDorVALIDATED.VALIDATED– - The session was validated and the User became KYC/KYB verified (indicated by the User object'sKYCLevel). When theStatuschanges toVALIDATED, the verified data inChecks.Datais used to replace existing data in the User object.REFUSED– The session was refused and the User is not KYC/KYB verified. TheChecks.CheckStatusshows which checks wereREFUSEDand theChecks.Reasonsshows the refused reason types and comment (which is custom text in the case of manual review for Legal users).EXPIRED– The IDV Session expired and can no longer be used. By default, this happens 7 days after theCreationDate. However, if the IDV Session contains the liveness step and that step has been started (the QR code was generated), the session instead expires 1 hour after the liveness step started. The IDV Session contains the liveness step for Natural users, Soletrader users, and Business/Organization users on the legacy integrated flow. In the multi-session PSC flow, the main IDV Session never contains the liveness step (so it always follows the 7-day rule) – the liveness check is performed in each PSC Session instead, which follows the same 7-day/1-hour rule independently.OUT_OF_DATE– The IDV Session is not valid because the user's KYC/KYB verification status was downgraded by Mangopay.
Unix timestamp (UTC) of the date and time the object was created.
Unix timestamp (UTC) of the date and time the session was last updated.
The checks performed automatically during the session.
This array is empty when Status is PENDING and may contain any number of objects depending on the outcome.
The list of persons of significant control (PSCs) declared during the session.
Only returned if the multi-session PSC flow is activated for BUSINESS and ORGANIZATION Legal Users.
This array is empty or null when not applicable.