List all KYC Documents

GET

/v2.01/:ClientId/kyc/documents

GET

/v2.01/:ClientId/kyc/documents

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/kyc/documents \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "Type": "REGISTRATION_PROOF",
4     "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
5     "Flags": [],
6     "Id": "kyc_01JA5M25P7D6V54J72ENGMPH9Y",
7     "Tag": "Created using Mangopay API Postman Collection",
8     "CreationDate": 1728913151,
9     "ProcessedDate": null,
10     "Status": "VALIDATION_ASKED",
11     "RefusedReasonType": null,
12     "RefusedReasonMessage": null
13   },
14   {
15     "Type": "IDENTITY_PROOF",
16     "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
17     "Flags": [],
18     "Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
19     "Tag": "Created using Mangopay API Postman Collection",
20     "CreationDate": 1728913167,
21     "ProcessedDate": 1728913173,
22     "Status": "VALIDATED",
23     "RefusedReasonType": null,
24     "RefusedReasonMessage": null
25   }
26 ]

Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution

Mangopay’s hosted KYC/KYB solution is becoming mandatory for all platforms (relying on the IDV Session object). The legacy KYC Document endpoints remain available for the sole purposes of sending additional documents, but this use case will also be handled by the hosted solution in future.

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution** Mangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms (relying on the [IDV Session](/api-reference/idv-sessions/idv-session-object) object). The legacy KYC Document endpoints remain available for the sole purposes of [sending additional documents](/guides/users/verification/hosted/integration#sending-additional-documents), but this use case will also be handled by the hosted solution in future. </Warning>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Query parameters

StatusstringOptional

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

The status of the KYC Document. You can filter on multiple values by separating them with a comma.

TypestringOptional

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

The type of the KYC Document. You can filter on multiple values by separating them with a comma.

BeforeDateintegerOptional

The date before which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateintegerOptional

The date after which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Response

Success

Array (KYCDocument)list of objects

The list of KYC documents created by the platform.