API References

This endpoint retrieves a specific platform.

HTTP Request

GET /v1/platforms/:id

The request command returns JSON structured like this:


{
  "id": 1,
  "subdomain": "ldug",
  "name": "LeihDeinerUmweltGeld",
  "operating_company_name": "CrowdDesk GmbH",
  "operating_company_location": "Frankfurt",
  "operating_company_url": "http://www.crowddesk.de",
  "mail_from_name": "CrowdDesk Skynet",
  "mail_from_address": "skynet@crowddesk.de",
  "...": "..."
}

This may be only an extract of the provided data. Returned attributes might differ based on access rights.

This endpoint retrieves all projects of the platform based on the API token.

See endpoint for getting a specific project object for more information.

HTTP Request

GET /v1/projects

This endpoint retrieves a specific project.

HTTP Request

GET /v1/projects/:id

Object attributes should be self-explanatory or will be documented otherwise here.

The request command returns JSON structured like this:

{
  "id": 1,
  "name": "Windpark Demo",
  "minimum_volume": "100000.0",
  "maximum_volume": "500000.0",
  "investments_count": 12,
  "investments_sum": "8450.0",
  "...": "..."
}

This may be only an extract of the provided data.

This endpoint retrieves all investments of a given project.

E.g. if you want to have the last 5 investments into this project, the endpoint would be …/projects/:id/investments?limit=5&sort=-checkout_finished_at.

See endpoint for getting a specific investment object for more information about the attributes.

HTTP Request

GET /v1/projects/:id/investments

With this endpoint you can simulate an investment into the project and retrieve all projected payouts (interest, repayments, taxes) that would occur. You can use this to show a table in your frontend that shows the earnings of an investment.

State changes from ‘pending’ to 'settled’ if there already was a payout from the project on this date.

HTTP Request

GET /v1/projects/:id/project_payouts

You can add the following GET parameters to your query:

The request command returns JSON structured like this:

[
    {
        "payout_date": "2017-12-31",
        "interest": "0.6",
        "repayment": "0.0",
        "taxes_kest": "0.15",
        "taxes_kist": "0.0",
        "taxes_soli": "0.01",
        "state": "pending",
        "gross_total": "0.6",
        "net_total": "0.44",
        "taxes_total": "0.16"
    },
    {
        "payout_date": "2018-06-01",
        "interest": "24.99",
        "repayment": "0.0",
        "taxes_kest": "6.25",
        "taxes_kist": "0.0",
        "taxes_soli": "0.34",
        "state": "pending",
        "gross_total": "24.99",
        "net_total": "18.4",
        "taxes_total": "6.59"
    }
]

This may be only an extract of the provided data.

This endpoint retrieves all emissions of the platform based on the API token.

See endpoint for getting a specific project object for more information.

HTTP Request

GET /v1/emissions

This endpoint retrieves a specific emission.

HTTP Request

GET /v1/emission/:id

Object attributes should be self-explanatory or will be documented otherwise here.

The request command returns JSON structured like this:

{
  "id": 1,
  "project_id": 1,
  "issuer_id": 1,
  "reference": "XYZ00123",
  "minimum_volume": "100000.0",
  "maximum_volume": "500000.0",
  "investable": true,
  "investment_amount_minimum": "100.0",
  "investment_amount_maximum": null,
  "investment_amount_partition": "50.0",
  "url_to_checkout_start": "https://invest.demo-platform.com/invest/XYZ00123",
  "...": "..."
}

This may be only an extract of the provided data. Returned attributes might differ based on access rights.

This endpoint retrieves all issuers of the platform based on the API token.

See endpoint for getting a specific project object for more information.

HTTP Request

GET /v1/issuers

This endpoint retrieves a specific issuer.

HTTP Request

GET /v1/issuers/:id

Object attributes should be self-explanatory or will be documented otherwise here.

The request command returns JSON structured like this:

{
  "id": 1,
  "name": "Muster Emittent GmbH",
  "street": "Berliner Str. 123",
  "zip_code": "10439",
  "city": "Berlin",
  "country_code": "DE",
  "register_number": "HRA 12345",
  "register_name": "Amtsgericht Berlin",
  "statutory_seat": "Frankfurt am Main"
}

This may be only an extract of the provided data. Returned attributes might differ based on access rights.

This endpoint retrieves all investors of the platform based on the API token.

See endpoint for getting a specific investor object for more information.

HTTP Request

GET /v1/investors

This endpoint retrieves a specific investor.

HTTP Request

GET /v1/investors/:id

Object attributes should be self-explanatory or will be documented otherwise here.

The request command returns JSON structured like this: 

{
  "id": 1,
  "reference": "LD275510",
  "type": "PrivateInvestor",
  "title": "Dr.",
  "gender": "male",
  "first_name": "Max",
  "last_name": "Mustermann",
  "email": "muster@mustermann.com",
  "wants_newsletter": false,
  "...": "..."
}

This may be only an extract of the provided data. Returned attributes might differ based on access rights.

This endpoint authenticates a specific investor, so it can be logged in on frontend sites.

If successful it will return the investor object, if not it will will raise  HTTP 401 Unauthorized.

HTTP Request

POST /v1/investors/authenticate

You might not only want to authenticate the investor but also to force a direct login. Therefore a redirect on our application is needed to set the according session cookies.

To do that, the returned investor object  after a create or authenticate will include an token_login_url attribute.

You have to send the investor to this url to be logged in. After a successful login the investor will be  redirected to the investor dashboard or to any url you added as a &redirect= GET parameter to the token_login_url.

The answers for a create or authenticate request will include the token_login_url


{
  "...": "...",
  "token_login_url": "https://demo.crowddesk.io/token_login?token=xyz123",
  "...": "..."
}

This endpoint retrieves all investments of a given investor.

See endpoint for getting a specific investment object for more information about the attributes.

HTTP Request

GET /v1/investors/:id/investments

This endpoint creates an investor.

Use the attribute * prevent_mail_dispatch* to tell the API if you do NOT want to have an “confirmation instructions” email to the user. By default we will send out an email for confirming the email address (double-opt-in).

The request returns the Investor object after successful creation.

HTTP Request

POST /v1/investors

Possible values to send in your JSON request are:

The request command for your JSON POST should like this:

{
  "gender": "male",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@mail.com",
  "password": "superduper",
  "accepts_terms_and_conditions": "true",
  "accepts_privacy_policy": "true",
  "prevent_mail_dispatch": true,
  "...": "..."
}

This shows only the required data for creating an Investor. 
See table for all possible attributes.

This endpoint updates an Investor.

The request returns the Investor object after successful update.

HTTP Request

PATCH /v1/investors/:id

Possible values to send in your JSON request are the same as in the Create request.

This endpoint is only available at the staging API!

This endpoint deletes an Investor.

The request returns 204 - No Content after a deleting the Investor.

HTTP Request

DELETE /v1/investors/:id

This endpoint retrieves all investments of the platform based on the API token.

See endpoint for getting a specific investment object for more information.

HTTP Request

GET /v1/investments

This endpoint retrieves a specific investment.

HTTP Request

GET /v1/investments/:id

Object attributes should be self-explanatory or will be documented otherwise here.

The request command returns JSON structured like this:

{
  "id": 1,
  "investor_id": 1,
  "emission_id": 1,
  "reference": "LD1232295093",
  "amount": "500.0",
  "type": "SubordinatedLoan",
  "state": "running",
  "checkout_started_at": "2018-01-06T16:20:53.028+01:00",
  "checkout_finished_at": "2018-01-06T16:21:19.400+01:00",
  "...": "..."
}

This may be only an extract of the provided data.

HTTP Request

POST /v1/newsletter_signups

The request command returns JSON structured like this:

{
  "email": "john@doe.com",
  "first_name": "John",
  "last_name": "Doe",
  "country": "US",
  "pending_newsletter_signup_url": "http://cd.domain.com/newsletter_signups/pending",
  "confirm_newsletter_signup_url": "http://cd.domain.com/newsletter_signups/BAh7CE[...]d747b0/confirm"
}

This endpoint retrieves all affiliate partners of the platform based on the API token.

See endpoint for getting a specific conversion object for more information.

HTTP Request

GET /v1/affiliates

This endpoint retrieves a specific affiliate partner.

HTTP Request

GET /v1/affiliates/:id

This endpoint retrieves a specific affiliate partner.

The request command returns JSON structured like this:

{
  "id": 1,
  "name": "Affiliate Name",
  "param": "affinm",
  "created_at": "2017-03-08T15:39:51.719+01:00",
  "updated_at": "2017-10-10T10:22:17.232+02:00"
}

This may be only an extract of the provided data. Returned attributes might differ based on access rights.

Affiliate Tracking Links

All affiliate links are always build like  .../?utm_source=##param## (without ##) - where utm_source is obligatory and used for identifying the affiliate partner, additional optional parameters are:

• utm_campaign

• utm_medium

• tm_term

• utm_content

• network_id

network_id is used for all affiliate partners which are networks, e.g. Zanox. This parameter than is the unique identifier for the specific affiliate behind the network.

This endpoint retrieves all affiliate conversions of the platform based on the API token.

See endpoint for getting a specific conversion object for more information.

HTTP Request

GET /v1/affiliate_conversions

This endpoint retrieves a specific affiliate conversion.

HTTP Request

GET /v1/affiliate_conversion/:id

With each AffiliateConversion you also get data to the associated  Affiliate, Investor, Investment. Investment is only present if the conversion was a “Sale” (customer invested) - otherwise, if only Investor is present, the conversion was a “Lead” (= customer registered).

The request command returns JSON structured like this:

{
  "id": 25,
  "created_at": "2017-04-12T10:59:21.032+02:00",
  "affiliate": {
    "id": 18,
    "name": "Demo Partner"
  },
  "utm_source": "demo",
  "utm_medium": "banner_big3",
  "utm_campaign": "test",
  "utm_term": null,
  "utm_content": null,
  "network_id": "xhkekweroj123",
  "investor": {
    "id": 312,
    "reference": "LD12345",
    "email_confirmed": true
  },
  "investment": {
    "id": 431,
    "reference": "LD123457991",
    "amount": "500.0",
    "state": "pending"
  }
}

Status of Lead/Sale

Investor.email_confirmed lets you determine if the customers has already gone through the double-opt-in process, so you can descide when the lead is “valid”.

If the conversion is a sale you can use  Investment.state to determine in which status the Investment is, you would only like to pay comission on running Investments. Possible states are:

• pending (still waiting for payin)

• running (money received, all good)

• canceled (something was wrong)

• settled (finished and repaid investment)

UTM Parameters & NetworkID

The  utm_ attributes let you know which parameters where used in the affiliate link originally. Those links are always build like .../?utm_source=partner-id&utm_... - where utm_source is obligatory and used for identifying the affiliate partner, all other parameters are optional.

network_id is used for all affiliate partners which are networks, e.g. Zanox. This parameter than is the unique identifier for the specific affiliate behind the network.

This endpoint creates an affiliate conversion. 

You would normally only use this endpoint to create an affiliate conversion for a the registration of the investor. This will happen in case you handled it by yourself over the API and thus we cannot track the corresponding conversion.

The request returns the AffiliateConversion object after successful creation, see the previous section.

HTTP Request

POST /v1/affiliate_conversions

Possible values to send in your JSON request are:

This endpoint retrieves all AdequacyAudits of the platform based on the API token.

See endpoint for getting a specific AdequacyAudit object for more information.

HTTP Request

GET /v1/adequacy_audits

This endpoint retrieves a specific AdequacyAudit.

HTTP Request

GET /v1/adequacy_audits/:id

AdequacyAudit = “Angemessenheitsprüfung” (or “Anlegerexploration” in the old system). This is a special legal requirement that may only effect German emissions.

The request command returns JSON structured like this:

{
  "id": 1,
  "investor_id": 1,
  "investment_id": 1,
  "created_at": "2017-11-12T14:36:16.000+01:00",
  "score": "9.6",
  "template": "Frankfurter Standard",
  "current_job": null,
  "current_job_finance": "Leitende Funkion Finanzabteilung",
  "past_job": "Sachbearbeiter Depotbank",
  "past_job_finance": null,
  "education": "Universität",
  "categories": {
      "Nachrangdarlehen": {
          "volume": "up_to_5000",
          "knowledge": "knowledge_existing",
          "consulting": "asset_management",
          "experience": "more_than_3_years",
          "transactions": "1_to_5"
      },
      "Offene Fonds und ETFs": {
          "volume": "5000_to_10000",
          "knowledge": "knowledge_existing",
          "consulting": "no_consulting",
          "experience": "more_than_3_years",
          "transactions": "more_than_15"
      },
      "Anleihen": {
          "volume": null,
          "knowledge": "no_knowledge_existing",
          "consulting": null,
          "experience": null,
          "transactions": null
      },
      "...": {}
  }
}

Parameters

The AdequacyAudit belongs to an Investment in which investment process the AdequacyAudit questionnaire was taken. To get easier connection to an Investor we added the  investor_id. If an Investor did an AdequacyAudit once, the old values will be loaded up during the next investment process.

That means you will end up receiving multiple AdequacyAudits for each Investor - be sure to include only the latest AdequacyAudit in your analysis, unless you want to have a deeper look at the differences between an Investors multiple AdequacyAudits.

Other object parameters:

Possible values & German translations

To give some values more sense and to know all possible values, we provide the according German translations:

Please contact us if you got further questions understanding this endpoint.

This endpoint retrieves all BonusCodeEntries of the platform based on the API token.

See endpoint for getting a specific BonusCodeEntry object for more information.

HTTP Request

GET /v1/bonus_code_entries

This endpoint retrieves a specific BonusCodeEntry.

HTTP Request

GET /v1/bonus_code_entries/:id

Object attributes should be self-explanatory or will be documented otherwise here.

The request command returns JSON structured like this:

{
    "id": 1,
    "investment_id": 2,
    "code": "ABC123XYZ",
    "state": "pending",
    "created_at": "2019-03-12T17:12:15.456+01:00",
    "updated_at": "2019-03-12T17:12:15.456+01:00"
}


This may be only an extract of the provided data. Returned attributes might differ based on access rights.

You can only change states from pending to settled or pending to rejected. 

Use the associated PUT requests:

HTTP Request

PUT /v1/bonus_code_entries/:id/settle

PUT /v1/bonus_code_entries/:id/reject

A successful request will return HTTP Code 200 with the BonusCodeEntry in its new state.

Wrong PUT requests will raise   HTTP 422 Unprocessable Entity.