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 user’s session where they can provide all the necessary data and documents for verification. Read guide

Attributes

Id
string

The unique identifier of the object.

Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

HostedUrl
string

The URL to redirect the user to for the hosted identity verification session.

ReturnUrl
string

Max. length: 500

The URL to which the user is returned after the hosted identity verification session, regardless of the outcome.

Status
string

The status of the overall IDV Session:

  • PENDING – The unique HostedUrl for the session has not yet been submitted by the user. This temporary state can transition to VALIDATED, REFUSED, or REVIEW.
  • 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 to REFUSED or VALIDATED.
  • VALIDATED – - The session was validated and the User became KYC/KYB verified (indicated by the User object’s KYCLevel). When the Status changes to VALIDATED, the verified data in Checks.Data is used to replace existing data in the User object.
  • REFUSED – The session was refused and the User is not KYC/KYB verified. The Checks.CheckStatus shows which checks were REFUSED and the Checks.Reasons shows the refused reason types and comment (which is custom text in the case of manual review for Legal users).
  • OUTDATED – The session is not valid because the user’s KYC/KYB verification status was downgraded by Mangopay.
UserId
string

The unique identifier of the user.

CreationDate
Unix timestamp

The date and time at which the object was created.

LastUpdate
Unix timestamp

The date and time at which the session was last updated.

Checks
array (object)

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.