v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
kycDocuments

Create a KYC Document Page

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

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.

Headers

Authorizationstring required

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.

Request body

Filestring required

Format: Base64 encoded file

The encoded file of the logo to upload.

Response

Success

KycDocumentsCreateKycDocumentPageResponse200 required

Empty response body