Step 1: Creating the seller
This step allows to create a request for registration by making a POST to the REGISTRATION resource with the complete details.
POST: https://secure.lyra.com/marketplace/registrations/
When a new seller is created, the following elements are controlled by the API and can provoke a 400X error code if they are not valid:
- the mandatory fields are populated;
- at least one legal representative is indicated and their coordinates are specified;
- each specified e- e- mail address is unique in the system;
- one (and only one) main activity has been specified;
- for each activity, an identifier must be specified (SIRET or legal_identifier);
- the activity identifiers are not duplicate in case where several activities are specified (i.e. the SIRET must be associated with only one activity).
The table below contains the fields that need to be provided when requesting to create a registration request
Check that each currency supported by the Marketplace is correctly associated with an IBAN.
| Name | Description | Format | Mandatory |
|---|---|---|---|
| marketplace | Marketplace identifier | ans..36 | X |
| reference | Technical reference of the registration | ans..255 | X |
| description | Description of the registration | ans..255 | |
| person_type | PM: Legal entity PP: Natural person |
X | |
| title | For natural persons: MR, MS or MRS | If person_type = PP | |
| first_name | For natural persons: First name | If person_type = PP | |
| last_name | For natural persons: Name | If person_type = PP | |
| name | Name of the seller | ans..255 | X |
| trading_name | For legal entities: Trading name | ans..255 | If person_type = PM |
| nature | Legal name | ans..255 | |
| iban | Payment IBAN | ans..34 | X |
| vat_number | VAT number When the merchant is not subject to VAT, indicate the VAT number of the Marketplace. | ans..16 | X |
| legal_form | Legal name of the sub-merchant. See the list of values below. |
ans..4 | X |
| economic_agent |
ISO code of the agent:
|
ans..255 | X |
| external_ref | External reference of the seller (can be used as identifier for sellers in other APIs) | ans.50 | |
| turnover | Estimated turnover (in cents) | Numeric | X |
| cashout_delay | Delay for release of funds (in days) | ans..180 | |
| address | Address of the seller’s company | X | |
| address.street_number | Street number | ans..5 | |
| address.street | Street type | ans..255 | |
| address.district | Address line 2 | ans..127 | |
| address.zipcode | Zip code | ans..64 | X |
| address.city | City | ans..128 | X |
| address.state | State/Province | ans..127 | |
| address.country | 2-letter country code (ISO 3166-1 alpha-2 code) | ans..2 | X |
| board | Legal representative [LEGAL_REP] and list of active beneficiaries [BENEFICIARY] | At least a legal representative | |
| board.role | Status of the individual within the company | [LEGAL_REP| BENEFICIARY] | X |
| board.title | Title of the individual | [MR|MS|MRS] | X |
| board.first_name | First name of the individual | ans..63 | X |
| board.last_name | Last name of the individual | ans..63 | X |
| board.birth_date | Birthdate of the individual | Date in YYYY-MM-DD format | X |
| board.birth_city | Place of birth of the individual | ans..128 | X |
| board.nationality | Nationality of the individual (ISO 3166-1 alpha-2 code of the country) | ans..2 | X |
| board.phone_number | Phone number of the individual | ans..32 | X |
| board.email | E-mail address of the individual | ans..150 | X |
| board.address | Personal address of the individual (Note: the same fields as for the company address are required for the address of each specified individual) | X | |
| activities | List of activities of the seller | X | |
| activity.name | Shop brand | Text | X |
| activity.url | Website of the shop | ans..200 | |
| activity.registration_date | Date of registration of the activity | Date in YYYY-MM-DD format | X |
| activity.siret | SIRET identifier of the activity | ans..14 | Mandatory if legal_identifier not filled in |
| activity.legal_identifier | Legal identifier of the activity | ans..20 | Mandatory if SIRET not filled in. |
| activity.mcc | MCC (Merchant Category Code) Example: 7997 for leisure clubs |
ans..4 | X |
| activity.naf | NAF code | ans..5 | |
| activity.is_principal | Indicates whether this is the seller’s main activity | [true|false] | X |
Value list of the attribute legal_form:
| Code | Label |
|---|---|
| 1000 | Individual entrepreneur |
| 2110 | Co-ownership between natural persons |
| 2120 | Co-ownership with the status of legal entity |
| 2210 | De facto company created between natural persons |
| 2220 | De facto company created with a legal entity |
| 2310 | Joint venture between natural persons |
| 2320 | Joint venture with a legal entity |
| 2385 | Joint venture between professionals |
| 2400 | Trust |
| 2700 | Parish not subject to concordat law |
| 2900 | Other private-law group not having legal personality |
| 3110 | Representation or commercial agency of a state or public body registered in the SCR |
| 3120 | Foreign commercial company registered in the SCR |
| 3205 | International organization |
| 3210 | State, community or foreign public institution |
| 3220 | Foreign company not registered in the SCR |
| 3290 | Other legal entity under foreign law |
| 4110 | National industrial or commercial public undertaking having a public accountant |
| 4120 | National industrial or commercial public undertaking not having a public accountant |
| 4130 | Public operator |
| 4140 | Local industrial or commercial public undertaking |
| 4150 | Management of an industrial or commercial local authority |
| 4160 | Bank of France institution |
| 5191 | Mutual guarantee company |
| 5192 | A popular bank cooperative |
| 5193 | Mutual maritime lending institution |
| 5194 | (Federal) mutual lending institution |
| 5195 | Registered cooperative association (local law of Alsace Moselle) |
| 5196 | Cooperative savings and provident bank |
| 5202 | Commercial partnership |
| 5203 | Cooperative commercial partnership |
| 5306 | Ordinary limited partnership |
| 5307 | Ordinary cooperative limited partnership |
| 5308 | Partnership limited by shares |
| 5309 | Cooperative partnership limited by shares |
| 5370 | Professional holding company Partnership limited by shares |
| 5385 | Partnership limited by shares for a professional private practice |
| 5410 | National limited liability company |
| 5415 | Mixed economy limited liability company |
| 5422 | Limited liability real estate company for trade and industry |
| 5426 | Limited liability real estate management company |
| 5430 | Limited liability company for land development and rural establishment |
| 5431 | Limited liability company with mixed agricultural purposes |
| 5432 | Limited liability company for collective agricultural purposes |
| 5442 | Limited liability allocation company |
| 5443 | Cooperative construction limited liability company |
| 5451 | Cooperative consumer limited liability company |
| 5453 | Cooperative craftworkers’ limited liability company |
| 5454 | Cooperative limited liability company for maritime purposes |
| 5455 | Cooperative limited liability transport company |
| 5458 | Cooperative workers’ production limited liability company |
| 5459 | Limited liability union of cooperative companies |
| 5460 | Other cooperative limited liability company |
| 5470 | Professional holding company Limited liability company |
| 5485 | Limited liability company for a professional private practice |
| 5498 | Single-person limited liability company |
| 5499 | Limited liability company (with no further details) |
| 5505 | Workers’ cooperative in the form of a public limited company with a board of directors |
| 5510 | National public limited company with a board of directors |
| 5515 | Mixed economy public limited company with a board of directors |
| 5520 | Open-end investment company with a board of directors |
| 5522 | Real estate public limited company for trade and industry with a board of directors |
| 5525 | Real estate investment public limited company with a board of directors |
| 5530 | Public limited company for land development and rural establishment with a board of directors |
| 5531 | Public limited company with mixed agricultural purposes with a board of directors |
| 5532 | Public limited company for collective agricultural purposes with a board of directors |
| 5542 | Public limited allocation company with a board of directors |
| 5543 | Public limited cooperative construction company with a board of directors |
| 5546 | Affordable housing public limited company with a board of directors |
| 5547 | Cooperative affordable housing production public limited company with a board of directors |
| 5548 | Real estate lending public limited company with a board of directors |
| 5551 | Consumer cooperative public limited company with a board of directors |
| 5552 | Retailers’ cooperative public limited company with a board of directors |
| 5553 | Cooperative craftworkers’ public limited company with a board of directors |
| 5554 | Cooperative public limited company for maritime purposes with a board of directors |
| 5555 | Cooperative transport public limited company with a board of directors |
| 5558 | Cooperative workers’ production public limited company with a board of directors |
| 5559 | Union of cooperative companies public limited company with a board of directors |
| 5560 | Other cooperative public limited company with a board of directors |
| 5570 | Professional holding company Public liability company with a board of directors |
| 5585 | Public limited company for a professional private practice with a board of directors |
| 5599 | Public limited company with a board of directors (real estate public limited company) |
| 5605 | Workers’ cooperative in the form of a public limited company with a management board |
| 5610 | National public limited company with a management board |
| 5615 | Mixed economy public limited company with a management board |
| 5620 | Fund in company form with a management board |
| 5622 | Real estate public limited company for trade and industry with a management board |
| 5625 | Real estate investment public limited company with a management board |
| 5630 | Public limited company for land development and rural establishment with a management board |
| 5631 | Public limited company with mixed agricultural purposes with a management board |
| 5632 | Public limited company for collective agricultural purposes with a management board |
| 5642 | Public limited allocation company with a management board |
| 5643 | Public limited cooperative construction company with a management board |
| 5646 | Affordable housing public limited company with a management board |
| 5647 | Cooperative affordable housing production public limited company with a management board |
| 5648 | Real estate lending public limited company with a management board |
| 5651 | Consumer cooperative public limited company with a management board |
| 5652 | Retailers’ cooperative public limited company with a management board |
| 5653 | Cooperative craftworkers’ public limited company with a management board |
| 5654 | Cooperative public limited company for maritime purposes with a management board |
| 5655 | Cooperative transport public limited company with a management board |
| 5658 | Cooperative workers’ production public limited company with a management board |
| 5659 | Union of cooperative companies public limited company with a management board |
| 5660 | Other cooperative public limited company with a management board |
| 5670 | Professional holding company Public limited company with a management board |
| 5685 | Public limited company for a professional private practice with a management board |
| 5699 | Public limited company with a management board (real estate public limited company) |
| 5710 | Simplified joint stock company |
| 5720 | Simplified joint stock company with a single shareholder or single person simplified joint stock company |
| 5770 | Professional holding company Simplified joint stock company |
| 5785 | Simplified joint stock company for a professional private practice |
| 5800 | European company |
| 6100 | Savings and provident bank |
| 6210 | European Economic Interest Group (EEIG) |
| 6220 | Economic interest grouping |
| 6316 | Cooperative for shared use of agricultural equipment |
| 6317 | Agricultural Cooperative Organization |
| 6318 | Agricultural cooperative |
| 6411 | Mutual insurance company |
| 6511 | Inter-professional outpatient care companies |
| 6521 | Collective real estate investment civil-law company |
| 6532 | Civil-law company for collective agricultural purposes |
| 6533 | Collective farming grouping |
| 6534 | Agricultural land grouping |
| 6535 | Agricultural land grouping |
| 6536 | Forestry grouping |
| 6537 | Pastoral grouping |
| 6538 | Land and rural grouping |
| 6539 | Land civil-law company |
| 6540 | Property civil-law company |
| 6541 | Property civil-law company for construction and sale |
| 6542 | Civil-law allocation company |
| 6543 | Civil construction cooperative company |
| 6544 | Property civil-law company for gradual accession to ownership |
| 6551 | Civil-law cooperative consumer company |
| 6554 | Civil-law company for maritime purposes |
| 6558 | Civil-law cooperative company between doctors |
| 6560 | Other civil-law cooperative company |
| 6561 | Civil-law professional partnership of lawyers |
| 6562 | Civil-law professional partnership of legal counsel |
| 6563 | Civil-law professional partnership of solicitors |
| 6564 | Civil-law professional partnership of bailiffs |
| 6565 | Civil-law professional partnership of notaries |
| 6566 | Civil-law professional partnership of valuers and auctioneers |
| 6567 | Civil-law professional partnership of clerks of the commercial court |
| 6568 | Civil-law professional partnership of legal advisors |
| 6569 | Civil-law professional partnership of auditors |
| 6571 | Civil-law professional partnership of doctors |
| 6572 | Civil-law professional partnership of dentists |
| 6573 | Civil-law professional partnership of nurses |
| 6574 | Civil-law professional partnership of masseurs and physiotherapists |
| 6575 | Civil-law professional partnership of directors of medical analysis laboratories |
| 6576 | Civil-law professional partnership of veterinary surgeons |
| 6577 | Civil-law professional partnership of expert surveyors |
| 6578 | Civil-law professional partnership of architects |
| 6585 | Other civil-law professional partnership |
| 6588 | Dairy civil-law partnership |
| 6589 | Resourcing civil-law partnership |
| 6595 | Local mutual lending bank |
| 6596 | Mutual agricultural lending bank |
| 6597 | Civil-law partnership for agricultural operations |
| 6598 | Limited liability farm |
| 6599 | Other civil-law company |
| 6901 | Other private-law person registered in the trade and companies register |
| 7111 | Constitutional authority |
| 7112 | Independent administrative authority |
| 7113 | Ministry |
| 7120 | Central department of a ministry |
| 7150 | Ministry of Defense department |
| 7160 | Decentralized department of a ministry (excluding Defense) with national jurisdiction |
| 7171 | Decentralized State department with (inter-)regional jurisdiction |
| 7172 | Decentralized State department with (inter-)departmental jurisdiction |
| 7179 | (Other) decentralized State department with territorial jurisdiction |
| 7190 | National school not having legal entity status |
| 7210 | Municipality and new municipality |
| 7220 | Department |
| 7225 | Overseas collectivity and territory |
| 7229 | (Other) territorial collectivity |
| 7230 | Region |
| 7312 | Associated municipality and delegated municipality |
| 7313 | Section of a municipality |
| 7314 | Conurbation |
| 7321 | Authorized trade union association |
| 7322 | Urban land association |
| 7323 | Land consolidation association |
| 7331 | Local public information undertaking |
| 7340 | Metropolitan center |
| 7341 | Sector of a municipality |
| 7342 | Urban district |
| 7343 | Urban community |
| 7344 | Metropolis |
| 7345 | Inter-municipality syndicate with multiple aims |
| 7346 | Community of districts |
| 7347 | Community of towns |
| 7348 | Community of an urban area |
| 7349 | Other local non-specialist public cooperation entity or agreement |
| 7351 | Inter-departmental institution or agreement |
| 7352 | Inter-regional institution or agreement |
| 7353 | Inter-municipality syndicate with a single aim |
| 7354 | Mixed closed syndicate |
| 7355 | Mixed open syndicate |
| 7356 | Trade union committee for the management of shared property of municipalities |
| 7357 | Center for territorial and rural balance |
| 7361 | Municipal social welfare center |
| 7362 | Education funding authority |
| 7363 | Municipal lending bank |
| 7364 | Hospital establishment |
| 7365 | Inter-hospital syndicate |
| 7366 | Local public social and medical/social undertaking |
| 7367 | Inter-municipality social welfare center |
| 7371 | Public affordable housing office |
| 7372 | Departmental fire and safety department |
| 7373 | Local public cultural undertaking |
| 7378 | Management of a local authority of an administrative nature |
| 7379 | (Other) local public administrative undertaking |
| 7381 | Consular body |
| 7382 | National public undertaking having a central administration role |
| 7383 | National public undertaking of a scientific, cultural and professional nature |
| 7384 | Other national public teaching undertaking |
| 7385 | Other national public administrative undertaking with limited territorial jurisdiction |
| 7389 | National public undertaking of an administrative nature |
| 7410 | Public interest grouping |
| 7430 | Public religious undertaking of Alsace-Lorraine |
| 7450 | Public administrative undertaking, army assistance centers |
| 7470 | Publicly-managed cooperative healthcare group |
| 7490 | Other administrative law legal entity |
| 8110 | General social security scheme |
| 8120 | Special social security scheme |
| 8130 | Supplementary pension institution |
| 8140 | Agricultural social mutual fund |
| 8150 | Sickness scheme for non-employed, non-agricultural workers |
| 8160 | Retirement scheme not forming part of the general social security scheme |
| 8170 | Unemployment insurance scheme |
| 8190 | Other social welfare scheme |
| 8210 | Mutual fund |
| 8250 | Mutual agricultural insurance |
| 8290 | Other mutual organization |
| 8310 | Central works council |
| 8311 | Works committee |
| 8410 | Employees’ trade union |
| 8420 | Employers’ association |
| 8450 | Professional body or similar |
| 8470 | Technical industrial center or professional committee for economic development |
| 8490 | Other professional organization |
| 8510 | Welfare institution |
| 8520 | Supplementary pension institution |
| 9110 | Association of co-owners |
| 9150 | Voluntary landowners’ association |
| 9210 | Undeclared association |
| 9220 | Declared association |
| 9221 | Declared association for integration through work |
| 9222 | Intermediary association |
| 9223 | Grouping of employers |
| 9224 | Association of lawyers with individual professional liability |
| 9230 | Declared recognized public interest association |
| 9240 | Religious order |
| 9260 | Local law association (Bas-Rhin, Haut-Rhin and Moselle) |
| 9300 | Foundation |
| 9900 | Other private-law legal entity |
| 9970 | Privately-managed cooperative healthcare grouping |
Example of a POST REGISTRATION call
{
"marketplace": "d085b6bb-4b8e-4f23-b84a-c9e5fafaf3dd",
"reference": "registration002",
"description": "Vendeur Acme Corp 20180116",
"person_type": "PM",
"name": "Acme Corporation",
"trading_name": "Acme Corp.",
"nature": "SARL",
"iban": "FR76300040000XXXXXXXXXX0143",
"vat_number": "FRXX123456789",
"legal_form": 5710,
"economic_agent": "ISO_303",
"external_ref": "acmeref",
"turnover": 100000000,
"address":{
"zipcode": "12345",
"street_number": "4",
"country":"FR",
"street": "rue des Souris",
"city": "BOUVISE"
},
"board": [{
"role": "LEGAL_REP","title": "MR",
"first_name": "Thomas",
"last_name": "Coyote",
"birth_date": "1949-09-17",
"birth_city": "BURBANK",
"nationality": "FR",
"phone_number": "0123456789",
"email": "thomas@acme.com",
"address":{
"zipcode": "12345",
"street_number": "12",
"country": "FR",
"street": "grande rue",
"city": "PARIS"
}
}],
"activities":[{
"name": "Acme Tennis Ball",
"url": "http://www.acmezzz.com",
"registration_date": "2017-03-24",
"siret": "99556699889944",
"mcc": "5995",
"naf": "4623Z",
"legal_identifier": "995566998",
"is_principal": "true"
}]
}