PUT
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
kyc
/
documents
/
{KycDocumentId}
{
    "Status": "VALIDATION_ASKED"
}  
{
    "Type": "IDENTITY_PROOF",
    "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
    "Flags": [],
    "Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1728913167,
    "ProcessedDate": null,
    "Status": "VALIDATION_ASKED",
    "RefusedReasonType": null,
    "RefusedReasonMessage": null
}

Read more about the KYC Document object →

Submitting a KYC Document consists in updating the object Status from CREATED to VALIDATION_ASKED

Once submitted, Mangopay’s teams review the document and validate or reject it. This process takes on average 24 hours (on bank working days).

We recommend that you set up a hook for the following event types in order to be notified of the outcome:

  • KYC_SUCCEEDED
  • KYC_FAILED

Path parameters

UserId
string
required

The unique identifier of the user.

KycDocumentId
string
required

The unique identifier of the KYC Document.

Body parameters

Status
string

Allowed values: VALIDATION_ASKED

The 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.

Responses

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