List all KYC Documents

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

The type of the document for the user verification.

The unique identifier of the user.

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.

The unique identifier of the object.

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

Returned values: CREATED, VALIDATION_ASKED, VALIDATED, REFUSED, OUT_OF_DATE

The status of the document:

• CREATED – The document is created, but not yet submitted to Mangopay.
• 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.

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.

Max. length: 255 characters

Default value: null

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