Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- IDV sessions
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Pay by bank
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Recipients
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View an IDV Session
See details of a hosted KYC/KYB session, outcome of checks, and verified data
// GET has no body parameters
{
"Id": "idnver_01JTGFRGJTHCKRZWAGSV1ZEF3W",
"Tag": "Created using the Mangopay API Postman collection",
"HostedUrl": "https://user-verification.sandbox.mangopay.com/6810d9b2c2885039758599bc?sessionId=6818d4082500001000a083b8&redirectURL=https%3A%2F%2Fexample.com%2F",
"ReturnUrl": "https://example.com/",
"Status": "PENDING",
"UserId": "user_m_01JTG7NDTE52MZCCF50QHJ870A",
"CreationDate": 1746457608,
"LastUpdate": 1746457608,
"Checks": []
}
Path parameters
The unique identifier of the IDV Session.
Responses
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The URL to redirect the user to for the hosted identity verification session.
Max. length: 500
The URL to which the user is returned after the hosted identity verification session, regardless of the outcome.
The status of the overall IDV Session:
PENDING– The uniqueHostedUrlfor the session has not yet been submitted by the user. This temporary state can transition toVALIDATED,REFUSED, orREVIEW.REVIEW– One or more automated checks was neither successful nor refused, so the session was sent for manual review by Mangopay’s teams. This temporary state is only applicable to Legal users and can transition toREFUSEDorVALIDATED.VALIDATED– - The session was validated and the User became KYC/KYB verified (indicated by the User object’sKYCLevel). When theStatuschanges toVALIDATED, the verified data inChecks.Datais used to replace existing data in the User object.REFUSED– The session was refused and the User is not KYC/KYB verified. TheChecks.CheckStatusshows which checks wereREFUSEDand theChecks.Reasonsshows the refused reason types and comment (which is custom text in the case of manual review for Legal users).OUTDATED– The session is not valid because the user’s KYC/KYB verification status was downgraded by Mangopay.
The unique identifier of the user.
The date and time at which the object was created.
The date and time at which the session was last updated.
The checks performed automatically during the session.
This array is empty when Status is PENDING and may contain any number of objects depending on the outcome.
The unique identifier of the verification check.
Type of check carried out during the session depending on the user type:
IDENTITY_DOCUMENT_VERIFICATION- Verifies the authenticity of the identity document, the liveness of the selfie, and that the selfie matches the identity document photo.IDV_AGE_CHECK- Checks whether the individual on the identity document meets the minimum age requirement for Mangopay users (age 18).BUSINESS_VERIFICATION- Looks up the business details entered by the user during the session in the national registry to find a match.IDV_NAME_MATCH_CHECK- Checks whether the first name, last name and date of birth of the identity document match theFirstName,LastName, andBirthdayof the Natural user object orLegalRepresentativeof the Legal user object.BUSINESS_NAME_MATCH- Checks whether the name on the identity document is present in the name of the registered sole proprietor in the relevant national registry.BUSINESS_INSIGHTS_MATCH- Checks whether the name on the identity document matches one of the directors listed in the national registry, and whether the PSC data declared in the session is coherent with the PSC data in the registry.
For information on which checks are performed for which user type and in which cases, see the user flows and checks performed.
Returned values: VALIDATED, REFUSED
The status of the verification check.
The reasons that the check was refused, which may be returned if CheckStatus was REFUSED (depending on the check type).
The date and time at which the check was created.
The date and time at which the check was last updated.
The data extracted and verified during the check.
This array may be empty if no data was extracted or is not applicable for the check.
The type of the data.
For a Natural user:
FIRST_NAMELAST_NAMEBIRTHDATE
For a Legal user:
COMPANY_NAMECOMPANY_NUMBERLEGAL_REPRESENTATIVE_FIRST_NAMELEGAL_REPRESENTATIVE_LAST_NAMELEGAL_REPRESENTATIVE_BIRTHDATE
The value of the data. The value may be null or an empty string if data extraction was not possible but the check was still carried out.
// GET has no body parameters
{
"Id": "idnver_01JTGFRGJTHCKRZWAGSV1ZEF3W",
"Tag": "Created using the Mangopay API Postman collection",
"HostedUrl": "https://user-verification.sandbox.mangopay.com/6810d9b2c2885039758599bc?sessionId=6818d4082500001000a083b8&redirectURL=https%3A%2F%2Fexample.com%2F",
"ReturnUrl": "https://example.com/",
"Status": "PENDING",
"UserId": "user_m_01JTG7NDTE52MZCCF50QHJ870A",
"CreationDate": 1746457608,
"LastUpdate": 1746457608,
"Checks": []
}
Was this page helpful?
// GET has no body parameters
{
"Id": "idnver_01JTGFRGJTHCKRZWAGSV1ZEF3W",
"Tag": "Created using the Mangopay API Postman collection",
"HostedUrl": "https://user-verification.sandbox.mangopay.com/6810d9b2c2885039758599bc?sessionId=6818d4082500001000a083b8&redirectURL=https%3A%2F%2Fexample.com%2F",
"ReturnUrl": "https://example.com/",
"Status": "PENDING",
"UserId": "user_m_01JTG7NDTE52MZCCF50QHJ870A",
"CreationDate": 1746457608,
"LastUpdate": 1746457608,
"Checks": []
}