POST
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
identity-verifications
{
    "ReturnUrl": "https://example.com",
    "Tag": "Created using the Mangopay API Postman collection"
}

{
    "Id": "idnver_01JH2ZK1MKAMG5H2Q20M5K6020",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1736340768,
    "HostedUrl": "https://user-verification.sandbox.mangopay.com/66ebfacebd780d434e8e6a9d?sessionId=677e75212400002f00a6edd0&redirectURL=https%3A%2F%2Fexample.com",
    "Status": "PENDING",
    "ReturnUrl": "https://example.com"
}

Note – Activation required

The hosted KYC/KYB verification feature must be activated by Mangopay. Contact our teams via the Dashboard to get started.

Note – Available for Natural, Soletrader, and Business

An IDV Session can only be created for Natural and Legal Users whose UserCategory is OWNER.

For Legal users, the feature is only available for LegalPersonType values BUSINESS and SOLETRADER.

​
Path parameters

​
UserId
string
required

The unique identifier of the user.

​
Body parameters

​
ReturnUrl
string
required

Max. length: 500

The URL to which the user is returned after the hosted identity verification session, regardless of the outcome.

​
Tag
string
required

Max. length: 255 characters

Custom data that you can add to this object.

​
Responses

{
    "Id": "idnver_01JH2ZK1MKAMG5H2Q20M5K6020",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1736340768,
    "HostedUrl": "https://user-verification.sandbox.mangopay.com/66ebfacebd780d434e8e6a9d?sessionId=677e75212400002f00a6edd0&redirectURL=https%3A%2F%2Fexample.com",
    "Status": "PENDING",
    "ReturnUrl": "https://example.com"
}

{
    "ReturnUrl": "https://example.com",
    "Tag": "Created using the Mangopay API Postman collection"
}