> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mangopay.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server. # View the Verified Identity of a User GET https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/verified-identity 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. Reference: https://docs.mangopay.com/api-reference/user-verified-identity/view-user-verified-identity ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, 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. ## Servers - `https://api.sandbox.mangopay.com` (Sandbox, default) - `https://api.mangopay.com` (Production) - `https://api-mtls.sandbox.mangopay.com` (mTLS Sandbox) - `https://api-mtls.mangopay.com` (mTLS Production) ## Request ### Path parameters - `ClientId` (string, required) — Platform's API account identifier, associated with the API key. - `UserId` (string, required) — The unique identifier of the user. ## Response ### 200 Success - `ViewUserVerifiedIdentityResponse` ## Errors ### 400 Bad Request Error Returned if the `ClientId` or `UserId` is incorrect, or if the user's KYC/KYB verification is not validated. - `Message` (string, optional) — Description of the error. - `Type` (string, optional) — The category of the error. - `Id` (string, optional) — Unique identifier of the error instance, useful when contacting Mangopay for support. - `Date` (double, optional) — Unix timestamp (UTC) of the date and time the error was triggered. - `errors` (map from string to string, optional, nullable) — Object containing one or more field-level errors. ### 403 Forbidden Error Returned if the endpoint is not activated or the API key does not have the correct permissions. - `Message` (string, optional) — Description of the error. - `Type` (string, optional) — The category of the error. - `Id` (string, optional) — Unique identifier of the error instance, useful when contacting Mangopay for support. - `Date` (double, optional) — Unix timestamp (UTC) of the date and time the error was triggered. - `errors` (map from string to string, optional, nullable) — Object containing one or more field-level errors. ### 404 Not Found Error Returned if the user cannot be found for the platform, or if the user's verification documents cannot be retrieved. - `Message` (string, optional) — Description of the error. - `Type` (string, optional) — The category of the error. - `Id` (string, optional) — Unique identifier of the error instance, useful when contacting Mangopay for support. - `Date` (double, optional) — Unix timestamp (UTC) of the date and time the error was triggered. - `errors` (map from string to string, optional, nullable) — Object containing one or more field-level errors. ## Types ### NaturalUserVerifiedIdentityResponse 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. - `ClientId` (string, optional) — Platform's API account identifier, as sent in the request. - `UserId` (string, optional) — The unique identifier of the user, as sent in the request. - `UserType` (string, optional) — **Returned value:** `NATURAL` The type of the user, which determines the payload returned. - `FirstName` (string, optional, nullable) — The verified first name of the user. - `LastName` (string, optional, nullable) — The verified last name of the user. - `BirthdayDate` (string, optional, nullable) — Format: ISO 8601 date-time (for example, `1990-01-01T00:00:00Z`) The verified date of birth of the user. - `Nationality` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The verified nationality of the user. - `CountryOfResidence` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The verified country of residence of the user. - `Address` (VerifiedIdentityAddress, optional) — The verified postal address. This property is omitted from the response if no usable verified address is available. - `Documents` (list of VerifiedIdentityDocument, optional) — The non-expired verification documents of the user. The array is empty if no document is returned. ### LegalUserVerifiedIdentityResponse 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. - `ClientId` (string, optional) — Platform's API account identifier, as sent in the request. - `UserId` (string, optional) — The unique identifier of the user, as sent in the request. - `UserType` (string, optional) — **Returned values:** `LEGAL_BUSINESS`, `LEGAL_ORGANIZATION`, `LEGAL_PARTNERSHIP`, `LEGAL_SOLETRADER` The type of the user, which determines the payload returned. - `CompanyName` (string, optional, nullable) — The verified name of the company. - `CompanyNumber` (string, optional) — The verified registration number of the company. This property is omitted from the response if the company number is unavailable. - `HeadquartersAddress` (VerifiedIdentityAddress, optional) — The verified postal address. This property is omitted from the response if no usable verified address is available. - `LegalRepresentatives` (list of VerifiedIdentityLegalRepresentative, optional) — The verified legal representatives of the company, returned for users verified with [KYC Documents](/api-reference/kyc-documents/kyc-document-object). It represents the legal representative verified in the main verification session, and currently contains zero or one legal representative. Users verified with the [hosted KYC/KYB solution](/guides/users/verification/hosted) return their persons with significant control (PSCs) in `Pscs` instead, so do not rely on `LegalRepresentatives` being populated for them. - `Documents` (list of VerifiedIdentityDocument, optional) — The non-expired documents of the main verification session, which for a Legal User is the legal representative's session. The array is empty if no document is returned. - `Pscs` (list of VerifiedIdentityPSC, optional) — The verified persons with significant control (PSCs) of the company and their documents, returned for users verified with the [hosted KYC/KYB solution](/guides/users/verification/hosted). The array is empty if no PSC is returned. Do not use `LegalRepresentatives` as a substitute for the data returned in `Pscs`. ### VerifiedIdentityAddress The verified postal address. This property is omitted from the response if no usable verified address is available. - `AddressLine1` (string, optional, nullable) — The first line of the address. - `AddressLine2` (string, optional, nullable) — The second line of the address. - `City` (string, optional, nullable) — The city of the address. - `Region` (string, optional, nullable) — The state, region, or province of the address. - `PostalCode` (string, optional, nullable) — The postal code of the address. - `Country` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. ### VerifiedIdentityDocument A verification document validated by Mangopay. Only documents whose expiry date is today or later are returned, along with documents that have no expiry date. Documents are not filtered on `Status`. - `DocumentType` (string, optional) — **Example value:** `IDENTITY_PROOF` The type of the verification document. Treat this as an extensible value, because further values can be returned. - `Status` (string, optional) — **Example value:** `VALIDATED` The status returned for the document. Treat this as an extensible value, because further values can be returned. - `DocumentExpiryDate` (string, optional, nullable) — Format: ISO 8601 date-time (for example, `2030-06-30T00:00:00Z`) The expiry date of the document, if applicable. - `DocumentUrls` (list of string, optional) — The signed download URLs of the pages of the document, in page order. Each URL is generated when the endpoint is called and grants access for a limited validity period only, which is not returned as a separate property. Download the document before the URL expires, and call the endpoint again to obtain a new URL if you need access afterwards. Do not cache, persist, or share these URLs, and do not use them as document identifiers. ### VerifiedIdentityLegalRepresentative The verified legal representative of the company. - `FirstName` (string, optional, nullable) — The verified first name of the legal representative. - `LastName` (string, optional, nullable) — The verified last name of the legal representative. - `BirthdayDate` (string, optional, nullable) — Format: ISO 8601 date-time (for example, `1985-05-15T00:00:00Z`) The verified date of birth of the legal representative. - `Nationality` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The verified nationality of the legal representative. - `CountryOfResidence` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The verified country of residence of the legal representative. ### VerifiedIdentityPSC The verified person with significant control (PSC) of the company. - `PscExternalId` (string, optional) — The unique identifier of the PSC. - `PscType` (string, optional) — **Example values:** `DIRECTOR`, `SHAREHOLDER` The role or type of the PSC. Treat this as an extensible value, because further values can be returned. - `FirstName` (string, optional, nullable) — The verified first name of the PSC. - `LastName` (string, optional, nullable) — The verified last name of the PSC. - `BirthdayDate` (string, optional, nullable) — Format: ISO 8601 date-time (for example, `1978-09-20T00:00:00Z`) The verified date of birth of the PSC. - `Nationality` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The verified nationality of the PSC. - `CountryOfResidence` (string, optional, nullable) — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The verified country of residence of the PSC. - `Documents` (list of VerifiedIdentityDocument, optional) — The non-expired verification documents of the PSC. The array is empty if no document is returned. ## Examples ### Natural User **Response** ```json { "Address": { "AddressLine1": "10 rue de la Paix", "AddressLine2": null, "City": "Paris", "Country": "FR", "PostalCode": "75002", "Region": null }, "BirthdayDate": "1990-01-01T00:00:00Z", "ClientId": "your-client-id", "CountryOfResidence": "FR", "Documents": [ { "DocumentExpiryDate": "2030-06-30T00:00:00Z", "DocumentType": "IDENTITY_PROOF", "DocumentUrls": [ "https://d1a2b3c4d5e6f7.cloudfront.net/kyc/user_m_01JTG7NDTE52MZCCF50QHJ870A/identity-proof-page-1.pdf?Expires=1771592800&Signature=EXAMPLE&Key-Pair-Id=EXAMPLE" ], "Status": "VALIDATED" } ], "FirstName": "Alex", "LastName": "Martin", "Nationality": "FR", "UserId": "user_m_01JTG7NDTE52MZCCF50QHJ870A", "UserType": "NATURAL" } ``` ### Legal User **Response** ```json { "ClientId": "your-client-id", "CompanyName": "Example Marketplace SAS", "CompanyNumber": "123456789", "Documents": [ { "DocumentExpiryDate": null, "DocumentType": "IDENTITY_PROOF", "DocumentUrls": [ "https://d1a2b3c4d5e6f7.cloudfront.net/kyc/user_m_01JTG8QDVF63NADDG61RIK981B/identity-proof-page-1.pdf?Expires=1771592800&Signature=EXAMPLE&Key-Pair-Id=EXAMPLE" ], "Status": "VALIDATED" } ], "HeadquartersAddress": { "AddressLine1": "25 avenue de l'Opéra", "AddressLine2": null, "City": "Paris", "Country": "FR", "PostalCode": "75001", "Region": null }, "LegalRepresentatives": [ { "BirthdayDate": "1985-05-15T00:00:00Z", "CountryOfResidence": "FR", "FirstName": "Jane", "LastName": "Smith", "Nationality": "FR" } ], "Pscs": [ { "BirthdayDate": "1978-09-20T00:00:00Z", "CountryOfResidence": "FR", "Documents": [ { "DocumentExpiryDate": null, "DocumentType": "IDENTITY_PROOF", "DocumentUrls": [ "https://d1a2b3c4d5e6f7.cloudfront.net/kyc/psc_x_01KXQN5Y7NYQBYBGA9ESQ8KBAD/identity-proof-page-1.pdf?Expires=1771592800&Signature=EXAMPLE&Key-Pair-Id=EXAMPLE" ], "Status": "VALIDATED" } ], "FirstName": "Morgan", "LastName": "Taylor", "Nationality": "FR", "PscExternalId": "psc_x_01KXQN5Y7NYQBYBGA9ESQ8KBAD", "PscType": "DIRECTOR" } ], "UserId": "user_m_01JTG8QDVF63NADDG61RIK981B", "UserType": "LEGAL_BUSINESS" } ```