View a User's Verified Identity
Retrieve the identity information and verification documents validated by Mangopay for a user, based on their UserId.
The payload returned depends on the user's UserType, so always branch on this value rather than on the presence of an optional property.
The endpoint returns a verified identity only if all the following conditions are met:
- The Underwriting API is activated for the ClientId.
- The user exists for the ClientId.
- The user's KYC/KYB verification is validated.
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 is available only to platforms for which the Underwriting API is activated, and requires an access token with the underwriting.user.kyc read permission. Contact Mangopay to request access. </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