Submit a KYC Document

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

200

Type · string

Returned values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOF

The 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

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom 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_DATE

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.

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_PERSON

Returned 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 characters

Default value: null

Additional information about why the KYC Document was refused, provided by Mangopay’s team.

200

{
    "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
}

REST

{
    "Status": "VALIDATION_ASKED"
}