What is it ?
- an individual : each operator has the possibility to manage his data base of individuals such as operator interlocutor, delivery operator)
- an organisation : possibility to search an organisation among the list of the market operators
Parties will be used in the other APIs to assign a role to an individual or organization in the context of the API.
Use cases
#1 - I want to search for my organization entity to place a quote
I am in a sales administration team, I want to fill the needed information to buy a new access. The quote management api requires to pass a related organization as buyer.
#2 - I want to search for an individual and use it as an interlocutor to place an order
I am in a sales administration team, I want to fill the needed information to buy a new access. The product offering requires to pass a related party as customer interlocutor.
#3 - I want to retrieve the details of an individual
Other apis expose related individuals, I want to get the detail of those individuals
#4 - I want to create an individual
The needed individual do not exist yet, I want to create a new one
#5 - I want to update an individual
The needed individual exist but its information has changed, I want to update some part of it
Technical prerequisite
Tariff
This API is free
Get started now
Discover
Have a look at the full documentation in the Getting started and API reference tabs.
Subscribe
Use
You can use your app’s credentials to retrieve an access token.
Integrate the API in your service thanks to the API key and the access token.
Your service is now up and running!
After subscription, generate your client with toolkit generator as Open Api generator or Editor Swagger.