View the Verified Identity of a User

GET

/v2.01/:ClientId/users/:UserId/verified-identity

GET

/v2.01/:ClientId/users/:UserId/verified-identity

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

1 {
2   "Address": {
3     "AddressLine1": "10 rue de la Paix",
4     "AddressLine2": null,
5     "City": "Paris",
6     "Country": "FR",
7     "PostalCode": "75002",
8     "Region": null
9   },
10   "BirthdayDate": "1990-01-01T00:00:00Z",
11   "ClientId": "your-client-id",
12   "CountryOfResidence": "FR",
13   "Documents": [
14     {
15       "DocumentExpiryDate": "2030-06-30T00:00:00Z",
16       "DocumentType": "IDENTITY_PROOF",
17       "DocumentUrls": [
18         "https://d1a2b3c4d5e6f7.cloudfront.net/kyc/user_m_01JTG7NDTE52MZCCF50QHJ870A/identity-proof-page-1.pdf?Expires=1771592800&Signature=EXAMPLE&Key-Pair-Id=EXAMPLE"
19       ],
20       "Status": "VALIDATED"
21     }
22   ],
23   "FirstName": "Alex",
24   "LastName": "Martin",
25   "Nationality": "FR",
26   "UserId": "user_m_01JTG7NDTE52MZCCF50QHJ870A",
27   "UserType": "NATURAL"
28 }

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 – Feature activation required

This endpoint requires activation for your platform – contact Mangopay via the Dashboard to get started.

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>

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) 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

Naturalobject

Response if the user’s UserType is NATURAL.

Identity properties can be returned null even for a user whose KYC/KYB verification is validated, because the data available depends on the verification received for that user.

Legalobject

Response if the user’s UserType is LEGAL_BUSINESS, LEGAL_ORGANIZATION, LEGAL_PARTNERSHIP, or LEGAL_SOLETRADER.

Identity properties can be returned null even for a user whose KYC/KYB verification is validated, because the data available depends on the verification received for that user.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error