View a User (SCA)

GET

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

GET

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

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

{
  "Address": {
    "AddressLine1": "3 rue de la Cité",
    "AddressLine2": "Appartement 7",
    "City": "Paris",
    "Country": "FR",
    "PostalCode": "75004",
    "Region": "Ile-de-France"
  },
  "Birthday": null,
  "Capacity": "NORMAL",
  "CountryOfResidence": null,
  "CreationDate": 1734339135,
  "Email": "alex.smith@example.com",
  "FirstName": "Ruby",
  "Id": "user_m_01JF7AP1M46TR0JH7WBGPWK7D7",
  "IncomeRange": null,
  "KYCLevel": "LIGHT",
  "LastName": "Reinger",
  "Nationality": null,
  "Occupation": null,
  "PendingUserAction": null,
  "PersonType": "NATURAL",
  "PhoneNumber": null,
  "PhoneNumberCountry": null,
  "ProofOfAddress": null,
  "ProofOfIdentity": null,
  "Tag": "Created using the Mangopay API Postman collection",
  "TermsAndConditionsAccepted": false,
  "TermsAndConditionsAcceptedDate": null,
  "UserCategory": "PAYER",
  "UserStatus": "ACTIVE"
}

Retrieve a Natural or Legal User.

This endpoint returns the same data as the legacy GET View a User, including the new PENDING_USER_ACTION value for UserStatus, with two minor changes:

The PendingUserAction field, which is always null on this endpoint
For Legal users, the LegalRepresentative object, which contains the data for the legal representative

Note – RedirectUrl not available on this endpoint

The RedirectUrl is only returned on API calls that trigger SCA.

To obtain a new session link for an Owner, call the POST Enroll a User in SCA endpoint.

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

Natural Userobject

Response body for a Natural User. The same schema is returned for PAYER and OWNER users.

If UserCategory is PAYER, the following are returned null:

Birthday
Nationality
CountryOfResidence
Occupation
IncomeRange
TermsAndConditionsAcceptedDate

Legal Userobject

Response body for a Legal User. The same schema is returned for PAYER and OWNER users.

If UserCategory is PAYER, the following are returned null:

LegalRepresentative.Birthday
LegalRepresentative.Nationality
LegalRepresentative.CountryOfResidence
LegalRepresentative.Email
All HeadquartersAddress sub-properties
CompanyNumber
TermsAndConditionsAcceptedDate