• France
lyra.com
Search
Categories
Tags
docs.
France
Spain
Europe (English)
India
Home
Implementation
Embedded form (cards)
REST payment API
REST PCI-DSS payment API
REST SEPA API
Hosted payment
Data collection form
File exchange
Mobile payment
Snippets
Plugins
Marketplace
Back Office
Merchant Back Office
Expert Back Office
Guides
Help
FAQ
Video tutorials
Support

Transmitting your KYC (Know Your Customer) documents

This step will allow you to collect KYC documents in view of validating the seller.

The transmission is done file by file, with a multipart/form-data request on the following resource:

POST /registrations/{registration_uuid}/documents registrations_documents_create

and with the following parameters:

Property Description Format / Permissible values Mandatory (X)
file The file to be transmitted file (image or PDF) X
type

Type of document:

  • IDENTITY_CARD : National identity card
  • PASSPORT : Passport
  • RESIDENCE_PERMIT : Residence permit
  • IBAN : IBAN
  • KBIS : KBIS extract
  • COMPANY_BALANCE_SHEET : Balance sheet
  • JDD : Proof of address
IDENTITY_CARD, PASSPORT, RESIDENCE_PERMIT, IBAN, KBIS, COMPANY_BALANCE_SHEET X
reference Technical reference of the document ans..255 X
description Description of the document ans..255  
board_member uuid of the administrator associated with the document. an-36 X if type = IDENTITY_CARD, PASSPORT, RESIDENCE_PERMIT, JDD
additional_data Allows you to record other information, such as the IBAN for the IBAN document type.   X for the IBAN file type and if the seller has several accounts.

Example of KYC POST with Postman

Example of a KYC POST response

{
    "uuid": "7e6c47bd-7a66-4aed-a3a8-56d1b3f815e6",
    "created_at": "2022-03-23T13:32:41.640641Z",
    "updated_at": "2022-03-23T13:32:46.592960Z",
    "registration": "ebc05292-6d8e-4cff-a2fe-aba6e1a97c6a",
    "board_member": "b48cc6c4-6927-8743-1a97eb8450f8",
    "type": "PASSPORT",
    "reference": "kyc00001",
    "additional_data": "",
    "status": "CREATED"
}

The 3 mandatory document types are:

  • KBIS
  • IBAN
  • identity document, i.e. IDENTITY_CARD or PASSPORT or RESIDENCE_PERMIT

As soon as these have been successfully submitted, the enrollment request status will change to AWAITING_SUBMISSION.

Recruitment

Head Office :

LYRA NETWORK
109, rue de l’innovation
31670 Labège
FRANCE

2.8.1-doc-1.8