idvSessions

Retry a PSC Session

Changed on

Retry a PSC Session based on its Id. Send an empty body ({}) to use the existing details declared for the individual and only retry the liveness check, or else send updated details in the request body.

If the PSC's Status is PENDING_VALIDATION, the existing session link is returned. If the PSC's Status is VALIDATED or REJECTED, a new session link is generated. A PSC whose Status is ABANDONED cannot be retried. To add a missing PSC, contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a>, who will create the new PSC and provide you with a session link.

Read more about the multi-session PSC flow →

put/v2.01/{ClientId}/identity-verifications/{IdvSessionId}/pscs/{PscId}/retry

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/identity-verifications/{IdvSessionId}/pscs/{PscId}/retry
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

IdvSessionIdstring required

The unique identifier of the IDV Session.

PscIdstring required

The unique identifier of the PSC.

Request body

FirstNamestring

The first name of the PSC.

LastNamestring

The last name of the PSC.

Emailstring

The email address of the PSC.

DateOfBirthinteger

Unix timestamp (UTC) of the date of birth of the PSC.

Response

Success

Idstring

The unique identifier of the PSC.

FirstNamestring

The first name of the PSC.

LastNamestring

The last name of the PSC.

Emailstring

The email address of the PSC.

DateOfBirthinteger

Unix timestamp (UTC) of the date of birth of the PSC.

Countrystring

The country of the PSC (ISO 3166-1 alpha-2 format).

Nationalitystring

The nationality of the PSC (ISO 3166-1 alpha-2 format).

PscTypestring

The type of the PSC:

  • LEGAL_REP – The PSC is a legal representative only.
  • LEGAL_REP_AND_UBO – The PSC is both a legal representative and a beneficial owner.
  • UBO – The PSC is a beneficial owner only.
Statusstring

The status of the PSC session:

  • PENDING_VALIDATION – The PSC session link has been generated and is awaiting completion.
  • VALIDATED – The PSC session was validated.
  • REJECTED – One or more checks failed, or the PSC did not complete the verification within the allowed timeframe. By default, the PSC Session expires 7 days after its CreationDate, but if the PSC's liveness step has been started (the QR code was generated), it expires 1 hour after the liveness step started instead.
  • ABANDONED – The PSC session was abandoned by Mangopay, for example if it was a duplicate of another declared PSC.
CreationDateinteger

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

ValidationDateinteger nullable

Unix timestamp (UTC) of the date and time the PSC session was validated. Returns null if not yet validated.

HostedUrlstring

The URL to redirect the PSC to for the hosted verification session.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id retry_psc_session removed and replaced with idvSessions_retry_psc_session