Create a KYC Document

Path parameters

UserId

string

required

The unique identifier of the user.

Body parameters

Type

string

required

Allowed values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOFThe type of the document for the user verification.

Tag

string

Max. length: 255 charactersCustom data that you can add to this object.

Responses

200

400 - Natural user only allows IDENTITY_PROOF and ADDRESS_PROOF

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "da212cf3-7afb-4a49-9c6d-8fa2753f243c#1727446970",
    "Date": 1727446971,
    "errors": {
        "Type": "REGISTRATION_PROOF cannot be submitted for NATURAL_PERSON user"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "3824ad65-c0da-4da6-824c-697a58a77b2e#1727446982",
    "Date": 1727446983,
    "errors": {
        "Type": "ARTICLES_OF_ASSOCIATION cannot be submitted for NATURAL_PERSON user"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "d91835a1-ce46-4e55-866d-6f1e0de61e75#1727448032",
    "Date": 1727448034,
    "errors": {
        "Type": "SHAREHOLDER_DECLARATION cannot be submitted for NATURAL_PERSON user"
    }
}

400 - Legal users don't allow ADDRESS_PROOF

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "43cddfad-fad7-4ed5-a9c6-bcc4d4b0ef42#1727447421",
    "Date": 1727447422,
    "errors": {
        "Type": "ADDRESS_PROOF cannot be submitted for BUSINESS user"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "573e126e-800a-42c4-89cd-b78ff10f0327#1727447489",
    "Date": 1727447490,
    "errors": {
        "Type": "ADDRESS_PROOF cannot be submitted for PARTNERSHIP user"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "2fb6cf62-cfb4-4a62-9401-763a53d7f602#1727447342",
    "Date": 1727447343,
    "errors": {
        "Type": "ADDRESS_PROOF cannot be submitted for ORGANIZATION user"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "444f5241-5263-4cc0-9ad2-26c871a6cf44#1727447141",
    "Date": 1727447142,
    "errors": {
        "Type": "ADDRESS_PROOF cannot be submitted for SOLETRADER user"
    }
}

400 - Soletrader doesn't allow ARTICLES_OF_ASSOCIATION

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "fa1adc02-dc72-47be-ab3c-4a0a4ce4ef6b#1727447083",
    "Date": 1727447084,
    "errors": {
        "Type": "ARTICLES_OF_ASSOCIATION cannot be submitted for SOLETRADER user"
    }
}

{
    "Type": "IDENTITY_PROOF",
    "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
    "Flags": [],
    "Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1728913167,
    "ProcessedDate": null,
    "Status": "CREATED",
    "RefusedReasonType": null,
    "RefusedReasonMessage": null
}

{
    "Tag": "Created using MANGOPAY API Collection Postman",
    "Type": "IDENTITY_PROOF"
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

Path parameters

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

​Path parameters

​Body parameters

​Responses

Path parameters

Body parameters

Responses