Upload Documents for KYC (Know Your Customers)

post

https://ws.lemonway.fr/mb/env-name/prod/directkitrest/v2/accounts/{accountid}/documents/upload

KYC is a regulatory obligation for Payment Institutions. European Directive 2015/849 of the European Parliament states this requirement
for the prevention of the use of the financial system for the purposes of money laundering and terrorist financing.

To upload documents for KYC use the following guidelines:

Use JPG, JPEG, PNG or PDF (maximum 2 pages) for ID documentation only (for example: Passport, Driving Licence and Residence Permit).
Maximum file upload size is 4MB for automatic verification.
Minimum file upload size is 100KB.
Full Colour, and straighten file.
Card ID: Scan both sides. One file should contain both sides (maximum 2 pages).

Important Documents over 4MB and upto 10MB will be manually validated.
Note: TIFF format is not accepted.
Note: If a document has been rejected, it is still possible to use the same slot to upload a new file.

NEW:

Document rejection reason

When a KYC document has a REJECTED status, the response includes a subStatus field providing the reason for the rejection.

Example:

{
  "status": "REJECTED",
  "subStatus": "EXPIRED"
}

Possible subStatus values are:

subStatus	Description
`Incomplete`	The document is incomplete.
`InvalidFormat`	The document format is invalid.
`Expired`	The document has expired.
`WrongIndividual`	The document does not belong to the expected individual.
`NotSigned`	The document has not been signed.
`MissingPercentages`	Required ownership percentages are missing.
`MissingUboIds`	Required UBO identifiers are missing.
`MissingSides`	One or more required sides of the document are missing.
`WrongDocumentType`	The uploaded document does not match the expected document type.
`NotRequired`	The document is not required.
`OrganizationalChartRequired`	An organizational chart is required.
`UnofficialDocument`	The document is not considered an official document.
`MissingDate`	A required date is missing.
`Blurry`	The document is too blurry to be processed.
`Duplicate`	The document is a duplicate.
`ImageQuality`	The image quality is insufficient.
`Other`	The document was rejected for another reason.

Path Params

accountid

string

required

Account ID

Body Params

name

string

required

Document Name

type

int32

enum

required

Document Type:
Note:
If you have previously uploaded a document in a reserved slot(0-13) and need to upload another document of the same type, use the slot Other document(6, 14-20).
0 = ID card (both sides in one file).
1 = Proof of address.
2 = Scan of a proof of IBAN.
3 = Passport (European Union).
4 = Passport (outside the European Union).
5 = Residence permit (both sides in one file).
6 = Other document type.
7 = Official company registration document (Kbis extract or equivalent).
11 = Driver licence (both sides in one file).
12 = Status.
13 = Selfie.
14 = Other document type.
15 = Other document type.
16 = Other document type.
17 = Other document type.
18 = Other document type.
19 = Other document type.
20 = Other document type.
21 = SDD mandate.

buffer

string

required

Byte array with the document. Encode in base 64 if necessary.

sddMandateId

int64

Lets you upload your signed(with your own signing partner) mandate document, to validate a mandate ID you previously created with RegisterSddMandate.

Headers

Authorization

string

required

Authorization bearer (OAuth 2)

PSU-Accept-Language

string

Response language accepted by final client (PSU). English by default

PSU-IP-Address

string

required

IP address of the final client (PSU).

PSU-User-Agent

string

User-agent of the final client (PSU).

Responses

401

Unauthorized

500

InternalServerError

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Document rejection reason

200OK