kycDocuments

List all KYC Documents

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **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>

get/v2.01/{ClientId}/kyc/documents

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/kyc/documents
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

Query parameters

Statusstring

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.

Typestring

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.

BeforeDateinteger

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.

AfterDateinteger

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

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id list_kyc_documents removed and replaced with kycDocuments_list_kyc_documents