> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The KYC Document object

### Description

<Warning>
  **Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution**

  Mangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) 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](/api-reference/idv-sessions/idv-session-object) object, but the legacy KYC Document endpoints remain available for the purposes of [sending additional documents](/guides/users/verification/hosted/integration#sending-additional-documents) (although in future this use case will also be handled via the hosted experience).
</Warning>

The KYC Document object is a container to store files, uploaded using [POST Create a KYC Document Page](/api-reference/kyc-documents/create-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

<ParamField body="Type" type="string">
  **Returned values:** `IDENTITY_PROOF`, `REGISTRATION_PROOF`, `ARTICLES_OF_ASSOCIATION`, `SHAREHOLDER_DECLARATION`, `ADDRESS_PROOF`

  The type of the document for the user verification.
</ParamField>

<ParamField body="UserId" type="string">
  The unique identifier of the user.
</ParamField>

<ParamField body="Flags" type="array">
  **Returned values:** A code from the <a href="/guides/users/verification/documents/submission/refusals" target="_blank">Flags list</a>.

  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 <a href="/guides/users/verification/documents/submission/refusals" target="_blank">Flags list</a>.
</ParamField>

<ParamField body="Id" type="string">
  The unique identifier of the KYC Document.
</ParamField>

<ParamField body="Tag" type="string">
  Max. length: 255 characters

  Custom data that you can add to this object.
</ParamField>

<ParamField body="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ParamField>

<ParamField body="ProcessedDate" type="Unix timestamp">
  The date and time at which the document was processed by Mangopay’s team.
</ParamField>

<ParamField body="Status" type="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](/api-reference/kyc-documents/create-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.
</ParamField>

<ParamField body="RefusedReasonType" type="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 <a href="/guides/users/verification/documents/submission/refusals">refused reason types</a> for more information depending on the document type.
</ParamField>

<ParamField body="RefusedReasonMessage" type="string">
  Max. length: 255 characters

  **Default value:** null

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

### Related resources

<CardGroup cols={2}>
  <Card title="How to" href="/guides/users/verification/documents/submission/how-to">How to submit a KYC Document</Card>
  <Card title="Guide" href="/guides/users/verification">Learn about user verification</Card>
</CardGroup>