List PSC Sessions for a User

GET

/v2.01/:ClientId/users/:UserId/pscs

GET

/v2.01/:ClientId/users/:UserId/pscs

curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/pscs \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "Id": "psc_x_01M6DTZZC17A1P426F3WEE0G90",
    "SessionId": "idnver_01M6DTZZDFC3K9G9Z8Z0834GKV",
    "Status": "PENDING_VALIDATION",
    "HostedUrl": "https://user-verification.sandbox.mangopay.com/6a58df8c284bf54f4b788cae?sessionId=6ae85e274100004400452a97&theme={\\\"stepIconColor\\\"%3A\\\"%23867EFF\\\"%2C\\\"inputFieldBorderColor\\\"%3A\\\"%23867EFF\\\"%2C\\\"continueButtonValidColor\\\"%3A\\\"%2389E481\\\"%2C\\\"continueButtonInvalidColor\\\"%3A\\\"%2389E481\\\"%2C\\\"logo\\\"%3A\\\"https%3A%2F%2Fres.cloudinary.com%2Fmangopay-dev%2Fimage%2Fupload%2Fv1772722797%2Fmrebvcrkjgxnguvoelgj.png\\\"%2C\\\"logoPosition\\\"%3A\\\"top-right\\\"}",
    "CreationDate": 1793613364,
    "LastUpdate": 1793613364,
    "Data": [
      {
        "Type": "PSC_LEGAL_REPRESENTATIVE_FIRST_NAME",
        "Value": "Marc"
      },
      {
        "Type": "PSC_LEGAL_REPRESENTATIVE_LAST_NAME",
        "Value": "Dubois"
      },
      {
        "Type": "BUSINESS_PSC_NAME",
        "Value": "Example Holdings Ltd - 987654321 - FR"
      }
    ],
    "MainSessionId": "idnver_01M6DTVKPTYK7BA2AKCWVTYASK",
    "PscType": "LEGAL_REP_AND_UBO"
  },
  {
    "Id": "psc_x_01M6DTZZC1F7D4QK4G1ZSDF8T2",
    "SessionId": "idnver_01M6DTZZDNVD4J44J5V4SVP951",
    "Status": "PENDING_VALIDATION",
    "HostedUrl": "https://user-verification.sandbox.mangopay.com/6a58df8c284bf54f4b788cae?sessionId=6ae85e274100004400f9bda2&theme={\\\"stepIconColor\\\"%3A\\\"%23867EFF\\\"%2C\\\"inputFieldBorderColor\\\"%3A\\\"%23867EFF\\\"%2C\\\"continueButtonValidColor\\\"%3A\\\"%2389E481\\\"%2C\\\"continueButtonInvalidColor\\\"%3A\\\"%2389E481\\\"%2C\\\"logo\\\"%3A\\\"https%3A%2F%2Fres.cloudinary.com%2Fmangopay-dev%2Fimage%2Fupload%2Fv1772722797%2Fmrebvcrkjgxnguvoelgj.png\\\"%2C\\\"logoPosition\\\"%3A\\\"top-right\\\"}",
    "CreationDate": 1793613364,
    "LastUpdate": 1793613364,
    "Data": [
      {
        "Type": "FIRST_NAME",
        "Value": "Alexis"
      },
      {
        "Type": "LAST_NAME",
        "Value": "Moreau"
      }
    ],
    "MainSessionId": "idnver_01M6DTVKPTYK7BA2AKCWVTYASK",
    "PscType": "UBO"
  }
]

Retrieve all PSC Sessions declared for a user, across all IDV Sessions, including each PSC’s current Status and HostedUrl.

PSC Sessions are only generated once the main IDV Session is VALIDATED.

Read more about the multi-session PSC flow →

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired

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

UserIdstringRequired

The unique identifier of the user.

Response

Success

IdstringOptional

The unique identifier of the PSC.

SessionIdstringOptional

The unique identifier of the PSC's own hosted verification session.

StatusstringOptional

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.

HostedUrlstringOptional

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

CreationDateintegerOptional

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

LastUpdateintegerOptional

Unix timestamp (UTC) of the date and time the PSC Session was last updated.

Datalist of objectsOptional

The data associated with the PSC.

MainSessionIdstringOptional

The unique identifier of the main IDV Session under which the PSC was declared.

PscTypestringOptional

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.