kycDocuments

Create a KYC Document Page

Changed on

Upload a file to the KYC Document object

<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>

The KYC Document Page is a file attached to the KYC Document for Mangopay's teams to review.

You can upload up to 5 files to each KYC Document, and each upload requires a call to this endpoint. Each file can contain as many real-life pages as required.

To be able to upload a file using this endpoint:

  • The corresponding KYC Document Status must be CREATED
  • The File must be Base64 encoded and abide by the format and size constraints

Read more about the KYC Document object →

post/v2.01/{ClientId}/users/{UserId}/kyc/documents/{KycDocumentId}/pages

Request

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

Path parameters

ClientIdstring required

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

UserIdstring required

The unique identifier of the user.

KycDocumentIdstring required

The unique identifier of the KYC Document.

Request body

Filestring required

Format: Base64 encoded file

The encoded file of the logo to upload.

Response

Success

KycDocumentsCreateKycDocumentPageResponse200 required

Empty response body

Changes

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      api operation id create_kyc_document_page removed and replaced with kycDocuments_create_kyc_document_page