idvSessions

Create an IDV Session

Changed on

Initiate a hosted KYC/KYB session and obtain a unique URL for the hosted frontend experience.

By default, the returned HostedUrl must be completed and submitted within 7 days of creation. If the session contains a 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 steps presented to the user depend on their User type: Natural, Soletrader, and Business and Organization (or Business - Legacy / Organization - Legacy). If the user already has an IDV Session with a Status of PENDING, that existing session is returned instead of creating a new one.

Read more about hosted KYC/KYB →

post/v2.01/{ClientId}/users/{UserId}/identity-verifications

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/identity-verifications
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

UserIdstring required

The unique identifier of the user.

Request body

ReturnUrlstring required

Max. length: 500

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

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

SessionLanguagestring

Allowed values: de-DE, en-US, es-ES, fr-FR, it-IT, nl-NL, pt-PT, zh-Hans-CN

The initial language of the hosted identity verification session. If not sent, then the session takes the language of the user's browser (if supported), otherwise English. The user can change the language in the session.

This parameter is not returned in the API response, but it adds the lng query parameter to the HostedUrl value.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

HostedUrlstring

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

Statusstring

The status of the overall IDV Session:

  • PENDING – Session created. The HostedUrl is 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 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).
  • EXPIRED – The IDV Session expired and can no longer be used. By default, this happens 7 days after the CreationDate. 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.
ReturnUrlstring

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

Changes