The KYC Document object
Description
Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution
Mangopay’s hosted KYC/KYB solution allows your platform to onboard all users securely through an embedded experience, and is becoming mandatory for all platforms.
Users must be verified via a hosted IDV Session object, but the legacy KYC Document endpoints remain available for the purposes of sending additional documents (although in future this use case will also be handled via the hosted experience).
The KYC Document object is a container to store files, uploaded using POST Create a KYC Document Page, before being submitted to Mangopay’s teams for validation.
One KYC Document object is necessary for each type of document, and the object can contain up to 5 files.
Attributes
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 KYC Document.
Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.
The date and time at which the object was created.
The date and time at which the document was processed by Mangopay’s team.
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 theRefusedReasonTypeparameter.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.