View the Verified Identity of a User
Retrieve the identity information and verification documents validated by Mangopay for a User, based on their UserId.
The API response depends on the user's UserType:
- NATURAL – The verified personal identity and ID document.
- LEGAL_BUSINESS, LEGAL_ORGANIZATION, LEGAL_PARTNERSHIP, LEGAL_SOLETRADER – The verified information about the legal entity, the business documents, plus the declared legal representative or persons of significant control and their ID document(s).
The endpoint returns a verified identity if:
- The endpoint is activated for your platform's ClientId
- The user's KYC/KYB verification is validated (their KYCLevel is REGULAR)
- The user exists for the ClientId
A user whose verification is not validated returns a 400 error rather than a partial or declared identity.
<Note icon="fa-regular fa-circle-info"> **Note – Feature activation required**This endpoint requires activation for your platform – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> to get started. </Note>
Path parameters
Platform's API account identifier, associated with the API key.
The unique identifier of the user.
Headers
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.
Response
Success