Make a request to the Particeep API via the interactive swagger documentation

Why Swagger?

With the Swagger app you can:

• Send requests directly to our API to obtain information related to several parameters of your platform (such as email addresses for example).

⚠ WARNING:

• The Swagger is a tool to be used with precision because it directly impacts the information related to your platform.
• We strongly advise against any POST, PUT or DELETE request if you are using a white-label platform (this can desynchronize data with the complementary database linked to the white label).
• Particeep takes no responsibility for any change or loss of information related to an action on the Swagger other than a GET and any modification requiring action from Particeep will be billed according to our professional services schedule.

How do I get started with the Swagger?

• Log in with your administrator credentials,
• Go to https://api.particeep.com
• Once connected to the two URLs above, fill in the key corresponding to your Particeep environment on The Swagger URL

How do I connect my Particeep environment to Swagger?

• Copy your key present in the back-office URL:

• Then paste it into the URL of the Swagger:

You can make queries in the swagger.

Note, however, that putting the key in the URL is not enough, you must be logged in to the back-office administrator area.

Obtain information related to a user

In the Swagger:

• Click on User (in global service):

• Click on the first GET "Get information about user with ID" (user information with user ID).

• Fill in the reference of a user associated with your search

How does a referral associated with a user?

From your administrator back-office:

• Go to the user menu
• Click on the small symbol to the left of the search bar
• Check the "reference" box,
• Select the reference and copy it

• Paste the reference into the Swagger and click on "TRY IT OUT":

The result obtained on the user after the swagger request

You will get different kinds of information like

• email-address,
• the birth date,
• the name,
• first name,
• ..... all other information relating to a user's profile.

Obtain information related to a transaction

In the Swagger:

• Click on Fundraise (in the Funding section).
• Then click
• On Fundraise Loan to retrieve transaction information in debt and bond securities
• On Fundraise Equity to retrieve information on transactions in fund shares or in company shares (capital)
• Then click on the first GET "Get Find a Fundraise by ID" to retrieve the information of the operation based on its identifier

How does a reference associated with an operation?

From your administrator back-office:

• Go to the Operations menu
• Click on the drop-down menu "actions" of the operation
• Then click on "Edit details" or "Edit file" depending on the status of the operation
• Copy the code present in the URL as in the example below

The code corresponds to the key of the operation, it will always be present after the "fundraise /" in the URL

• Paste the code in the Swagger and click on "TRY IT OUT":

The result obtained on the operation after the swagger request

You will thus obtain all the key information related to the operation:

• Email-address
• The birth date
• The name
• First name
• ..... all other information relating to a user's profile.

Obtain information related to a transaction

In the Swagger:

• Click on the transaction menu
• Then click on the first GET "Get information about transaction with ID" to retrieve the transaction information based on its identifier

How does a reference associated with an operation?

From your administrator back-office:

• Go to the transaction menu then click on the small symbol to the left of the search bar,
• Check the "reference" box,
• Copy and paste the reference.

• Paste the reference in the Swagger and click on "TRY IT OUT":

• The result obtained on the transaction after the swagger request

You will get different types of information:

• The amount of the transaction
• The type of investment (loan/capital)
• Currency
• Expenses
• The reference of the associated project, and of the issuer
• ..... any other information relating to the transaction