Skip to main content
POST
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
kyc
/
documents
{
    "Tag": "accept",
    "Type": "IDENTITY_PROOF"
}  

{
    "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
}
Note – Use test data to simulate outcomeIn Sandbox, you can set the KYC Document Tag to accept to simulate acceptance of the document after submission. Other values are available to simulate different refusal reasons – see the guide for details.

​
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

​
Type
string
Returned values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOFThe type of the document for the user verification.
​
UserId
string
The unique identifier of the user.
​
Flags
array
Returned values: A code from the Flags list.The series of codes providing more precision regarding the reason why the identity proof document was refused. You can review the explanations for each code in the Flags list.
​
Id
string
The unique identifier of the KYC Document.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
ProcessedDate
Unix timestamp
The date and time at which the document was processed by Mangopay’s team.
​
Status
string
Returned values: CREATED, VALIDATION_ASKED, VALIDATED, REFUSED, OUT_OF_DATEThe status of the document:
  • CREATED – The document container is created and files can be uploaded using the POST Create a KYC Document Page endpoint before submission.
  • VALIDATION_ASKED – The document is submitted to Mangopay for validation.
  • VALIDATED – The document is validated by Mangopay’s teams.
  • REFUSED – The document is rejected by Mangopay’s teams and a new KYC Document object needs to be created to resubmit it. You can learn more about the reason why it was refused in the RefusedReasonType parameter.
  • OUT_OF_DATE – The document is downgraded and a new KYC Document object needs to be created to resubmit it.
​
RefusedReasonType
string
Returned values: DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSONReturned null unless Status is REFUSED.The reason for the document refusal. See the refused reason types for more information depending on the document type.
​
RefusedReasonMessage
string
Max. length: 255 charactersDefault value: nullAdditional information about why the KYC Document was refused, provided by Mangopay’s team.
{
    "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"
    }
}

{
    "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": "accept",
    "Type": "IDENTITY_PROOF"
}