WeCan.Fund API (v1) API Reference

Introduction

This document is for consultation only. It provides the necessary information to implement a front-end based on the WeCan.Fund API. But it is still a working document that will change until the first release of the API.

Requests and Responses

The API follows the typical RESTful design, using the HTTP verbs GET, POST, PUT and DELETE. All connections to the API are done in standard HTTPS with TLS. The content-type must be application/json, except for uploading files where it is multipart/form-data. The response codes follows the HTTP standard. In case of an error, an Error object is returned, explaining the cause of the problem.

Formats

The date format is the following YYYY-MM-dd (e.g.: 1985-12-31) and the date and time format is YYYY-MM-dd HH:mm:ss (e.g.: 1985-12-31 11:45:33). The monetary amounts are backed with a decimal(9,2) representation, avoiding rounding issue of floating point numbers. For all requests and responses, the encoding is utf-8.

API Endpoint
https://api.wecan.fund/
Schemes: https
Version: v1

Authentication

WeCan.Fund SSO

flow
accessCode
authorizationUrl
https://my.wecan.fund/o/authorize/
tokenUrl
https://my.wecan.fund/o/token/

brands

Get current brand

GET /v1/brands/my/

Get current brand . Returns detailled information about the currently authenticated brand

200 OK

Returns the information about the current brand

Response Example (200 OK)
{
  "owner": "string",
  "name": "string",
  "url": "string"
}

documents

List document types

GET /v1/documents/types/

List document types . Return the list of all document types (internal + custom).

all

If set to 'true', include disabled types (Optional).

type
string
in
query
200 OK

Returns the document types (custom types have an additional metadata field).

Response Example (200 OK)
{
  "key": "string",
  "id": "integer",
  "disabled": "boolean",
  "description": "string",
  "type": "string",
  "title": "string",
  "linkable_types": "string"
}

Create a new document type

POST /v1/documents/types/

Create a new document type

metadata: string

Additional information stored in JSON.

key: string

A unique to the brand key for refering to this document type.

title: string

The name of the document type

description: string

The description of the document type

Request Example
{
  "metadata": "string",
  "key": "string",
  "title": "string",
  "description": "string"
}
201 Created

Returns the document type just created.

Response Example (201 Created)
{
  "key": "string",
  "id": "integer",
  "type": "string",
  "description": "string",
  "disabled": "boolean",
  "metadata": "string",
  "title": "string"
}

Update a document type

PUT /v1/documents/types/{id}/

Update a document type . Only custom document type of the current brand can be edited.

metadata: string

Additional information stored in JSON.

key: string

A unique to the brand key for refering to this document type.

title: string

The name of the document type

description: string

The description of the document type

id

(no description)

type
string
in
path
Request Example
{
  "metadata": "string",
  "key": "string",
  "title": "string",
  "description": "string"
}
200 OK

Returns the document type just edited.

Response Example (200 OK)
{
  "key": "string",
  "id": "integer",
  "type": "string",
  "description": "string",
  "disabled": "boolean",
  "metadata": "string",
  "title": "string"
}

Disable a document type

DELETE /v1/documents/types/{id}/

Disable a document type . Only custom document type of the current brand can be disabled. Disabled document types cannot be re-enabled, but are still visible in the list with the "all" option.

id

(no description)

type
string
in
path
204 No Content

The document type has been correctly disabled.

List documents

GET /v1/documents/{linked_type}/{type_id}/

List documents for a specific object type and primary key (pk). For example, if you want to get the list of documents for a user with id 42, use /user/42 The results are paginated and wrapped in a JSON object with 'count' and 'results' properties. The page length is 25.

type_id

(no description)

type
string
in
path
linked_type

(no description)

type
string
in
path
type

Id of a document type. If specified, only documents of this type will be returned (Optional).

type
string
in
query
page

A page number within the paginated result set.

type
integer
in
query
200 OK

Returns the list of documents details.

Response Example (200 OK)
{
  "type_id": "string",
  "filename": "string",
  "id": "integer",
  "type": "string",
  "linked_type": "string",
  "creation_date": "string"
}

Upload a document

POST /v1/documents/{linked_type}/{type_id}/

Upload a document for a specific type and pk. See "List documents" for an example usage of linked_type and type_id.

type_id

(no description)

type
string
in
path
linked_type

(no description)

type
string
in
path
type

Id of document type. Mandatory.

type
string
in
query
file

(no description)

type
file
in
formData
201 Created

The file has been correctly uploaded.

Response Example (201 Created)
{
  "type_id": "string",
  "filename": "string",
  "id": "integer",
  "type": "string",
  "linked_type": "string",
  "creation_date": "string"
}

Download a document

GET /v1/documents/{linked_type}/{type_id}/{id}/

Download a document . See "List documents" for an example usage of linked_type and type_id. Id is the document id, returned in the upload response or while listing documents.

id

(no description)

type
string
in
path
type_id

(no description)

type
string
in
path
linked_type

(no description)

type
string
in
path
200 OK

Returns the document content as an attachement.

Delete a document

DELETE /v1/documents/{linked_type}/{type_id}/{id}/

Delete a document . This action is permanent. See "List documents" for an example usage of linked_type and type_id. Id is the document id, returned in the upload response or while listing documents.

id

(no description)

type
string
in
path
type_id

(no description)

type
string
in
path
linked_type

(no description)

type
string
in
path
204 No Content

The document has been correctly deleted.

miscellaneous

Test connectivity

GET /v1/miscellaneous/ping

Test connectivity to the backend. It also retrieves the basic authentification infos.

200 OK

Returns the connection information.

notifications

List notifications

GET /v1/notifications/

List notifications . By default, returns only unseen notification. The results are paginated and wrapped in a JSON object with 'count' and 'results' properties. The page length is 25.

mode

If equal to 'all', will return all notifications (Optional).

type
string
in
query
page

A page number within the paginated result set.

type
integer
in
query
200 OK

Returns the list of notifications.

Response Example (200 OK)
{
  "destination_link": "string",
  "key": "string",
  "brand": "string",
  "species": "string",
  "id": "integer",
  "seen_date": "string",
  "creation_date": "string",
  "seen": "boolean",
  "metadata": "string",
  "public": "boolean"
}

Mark a notification as read

POST /v1/notifications/{id}/

Mark a notification as read

id

(no description)

type
string
in
path
seen

Set this to 'ignored' if the user want to mark the notification as read, but ignored it (Optional).

type
string
in
query
201 Created

The notification has been marked as read.

processes

List processes

GET /v1/processes/

List processes that are currently in progress for the curent user.

200 OK

Returns the processes. The actual structure depends on the process type.

Response Example (200 OK)
{
  "started_date": "string",
  "status": "string",
  "status_display": "string",
  "id": "integer",
  "display_name": "string",
  "ended_date": "string",
  "current_step": "string"
}

Get a process

GET /v1/processes/{id}/

Get a process with detailled information about its steps.

id

(no description)

type
string
in
path
200 OK

Returns the process and steps. The actual structure depends on the process type.

Response Example (200 OK)
{
  "steps": [
    "string"
  ],
  "started_date": "string",
  "status": "string",
  "status_display": "string",
  "id": "integer",
  "display_name": "string",
  "ended_date": "string",
  "current_step": "string"
}

projects

List projects

GET /v1/projects/

List projects that are managed by the current user (or also the public ones). The results are paginated and wrapped in a JSON object with 'count' and 'results' properties. The page length is 25.

all

If set to 'true', lists also disabled projects (Optional)

type
string
in
query
public

If set to 'true', lists all public projects (Optional)

type
string
in
query
page

A page number within the paginated result set.

type
integer
in
query
200 OK

Returns the projects.

Response Example (200 OK)
{
  "card_picture": "string",
  "id": "integer",
  "short_project_description": "string",
  "title": "string",
  "owner": "string"
}

Create a new project

POST /v1/projects/

Create a new project

maximum_loan_amount: number
rate_interest: number

Expressed in percent. Only applicable in the case of a LENDING project. Default: 0

card_picture: string

The picture for the project. For reading, it returns the url. For writing you need to provide the image base64 encoded, like "data:image/jpg;base64, ". Minimum size 560x420px, but it can be any size larger than this as long as the ratio is preserved. Images with another ratio may be crop when displayed on aggregators.

facebook: string
currency: string

default: CHF

duration: integer

Number of months from the closing of the project until full refund of the lenders. This only applies to LENDING projects. Default: 3

linkedin: string
minimum_loan_amount: number
short_project_description: string
website: string
request_type: string

FUNDING (default option): Crowdfunding (in kind rewards), LENDING: Crowdlending (refund and interests), DONATION: Donation (no direct rewards)

amount_min: number

The minimal amount to succeed the project. (default: 0)

reimbursement: string

How should the loan (and interests) be reimbursed: do nothing, all at the end, or split in equal parts monthly or every three months (in this case the duration must be a multiple of 3). The default option is to do nothing, it must then be triggered through the dedicated API calls. Only used in the case of a LENDING project.

project_description: string

Expected format is HTML, ideally domain independant in terms of styles and media.

amount: number

The target of the fundraising (minimum and default: 30'000). In the case of a crowdlending, this is also the maximum amount that can be collected.

tags: string

List of tags for this project. You can use any string for this and you can use the List tags endpoint if you want to provide some autofill to the user, based on the previously seen tags for this brand. You can also choose to restrict the tags to your own list.

title: string

Max 60 char.

twitter: string
user_wallet: string

ID of the project owner's wallet.

owner: string

The owner of the project, who receives the money if it succeeds. It can be a user or a company.

location_coordinates: string

The location of the project, as geographic coordinates. E.g.: {"longitude": 6.565554141998291, "latitude"=46.52027836093017}

project_contact_email: string
campaign_end_date: string

Date at which the project automatically closes and switches to success or failure, depending on the amount collected.

location: string

The location of the project, as a place name.

Request Example
{
  "maximum_loan_amount": "number",
  "rate_interest": "number",
  "card_picture": "string",
  "facebook": "string",
  "currency": "string",
  "duration": "integer",
  "linkedin": "string",
  "minimum_loan_amount": "number",
  "short_project_description": "string",
  "website": "string",
  "request_type": "string",
  "amount_min": "number",
  "reimbursement": "string",
  "project_description": "string",
  "amount": "number",
  "tags": "string",
  "title": "string",
  "twitter": "string",
  "user_wallet": "string",
  "owner": "string",
  "location_coordinates": "string",
  "project_contact_email": "string",
  "campaign_end_date": "string",
  "location": "string"
}
201 Created

Returns the project just created.

Response Example (201 Created)
{
  "maximum_loan_amount": "number",
  "amount_min": "number",
  "vote_score": "integer",
  "owner": "string",
  "facebook": "string",
  "currency": "string",
  "duration": "integer",
  "linkedin": "string",
  "location_coordinates": "string",
  "wallet": "string",
  "minimum_loan_amount": "number",
  "short_project_description": "string",
  "website": "string",
  "request_type": "string",
  "num_vote_up": "integer",
  "rate_interest": "number",
  "campaign_end_date": "string",
  "num_vote_down": "integer",
  "amount": "number",
  "id": "integer",
  "tags": "string",
  "disabled": "boolean",
  "title": "string",
  "twitter": "string",
  "user_wallet": "string",
  "card_picture": "string",
  "project_description": "string",
  "project_contact_email": "string",
  "process_id": "string",
  "brand": "string",
  "reimbursement": "string",
  "commission": "number",
  "location": "string"
}

List tags

GET /v1/projects/tags/

List tags that are used by the current brand. The results are paginated and wrapped in a JSON object with 'count' and 'results' properties. The page length is 25.

page

A page number within the paginated result set.

type
integer
in
query
200 OK

Returns the tags.

Response Example (200 OK)
{
  "name": "string"
}

Get a project

GET /v1/projects/{id}/

Get a project

id

(no description)

type
string
in
path
200 OK

Returns the project.

Response Example (200 OK)
{
  "maximum_loan_amount": "number",
  "amount_min": "number",
  "vote_score": "integer",
  "owner": "string",
  "facebook": "string",
  "currency": "string",
  "duration": "integer",
  "linkedin": "string",
  "location_coordinates": "string",
  "wallet": "string",
  "minimum_loan_amount": "number",
  "short_project_description": "string",
  "website": "string",
  "request_type": "string",
  "num_vote_up": "integer",
  "rate_interest": "number",
  "campaign_end_date": "string",
  "num_vote_down": "integer",
  "amount": "number",
  "id": "integer",
  "tags": "string",
  "disabled": "boolean",
  "title": "string",
  "twitter": "string",
  "user_wallet": "string",
  "card_picture": "string",
  "project_description": "string",
  "project_contact_email": "string",
  "process_id": "string",
  "brand": "string",
  "reimbursement": "string",
  "commission": "number",
  "location": "string"
}

Update a project

PUT /v1/projects/{id}/

Update a project

maximum_loan_amount: number
rate_interest: number

Expressed in percent. Only applicable in the case of a LENDING project. Default: 0

card_picture: string

The picture for the project. For reading, it returns the url. For writing you need to provide the image base64 encoded, like "data:image/jpg;base64, ". Minimum size 560x420px, but it can be any size larger than this as long as the ratio is preserved. Images with another ratio may be crop when displayed on aggregators.

facebook: string
currency: string

default: CHF

duration: integer

Number of months from the closing of the project until full refund of the lenders. This only applies to LENDING projects. Default: 3

linkedin: string
minimum_loan_amount: number
short_project_description: string
website: string
request_type: string

FUNDING (default option): Crowdfunding (in kind rewards), LENDING: Crowdlending (refund and interests), DONATION: Donation (no direct rewards)

amount_min: number

The minimal amount to succeed the project. (default: 0)

reimbursement: string

How should the loan (and interests) be reimbursed: do nothing, all at the end, or split in equal parts monthly or every three months (in this case the duration must be a multiple of 3). The default option is to do nothing, it must then be triggered through the dedicated API calls. Only used in the case of a LENDING project.

project_description: string

Expected format is HTML, ideally domain independant in terms of styles and media.

amount: number

The target of the fundraising (minimum and default: 30'000). In the case of a crowdlending, this is also the maximum amount that can be collected.

tags: string

List of tags for this project. You can use any string for this and you can use the List tags endpoint if you want to provide some autofill to the user, based on the previously seen tags for this brand. You can also choose to restrict the tags to your own list.

title: string

Max 60 char.

twitter: string
user_wallet: string

ID of the project owner's wallet.

owner: string

The owner of the project, who receives the money if it succeeds. It can be a user or a company.

location_coordinates: string

The location of the project, as geographic coordinates. E.g.: {"longitude": 6.565554141998291, "latitude"=46.52027836093017}

project_contact_email: string
campaign_end_date: string

Date at which the project automatically closes and switches to success or failure, depending on the amount collected.

location: string

The location of the project, as a place name.

id

(no description)

type
string
in
path
Request Example
{
  "maximum_loan_amount": "number",
  "rate_interest": "number",
  "card_picture": "string",
  "facebook": "string",
  "currency": "string",
  "duration": "integer",
  "linkedin": "string",
  "minimum_loan_amount": "number",
  "short_project_description": "string",
  "website": "string",
  "request_type": "string",
  "amount_min": "number",
  "reimbursement": "string",
  "project_description": "string",
  "amount": "number",
  "tags": "string",
  "title": "string",
  "twitter": "string",
  "user_wallet": "string",
  "owner": "string",
  "location_coordinates": "string",
  "project_contact_email": "string",
  "campaign_end_date": "string",
  "location": "string"
}
200 OK

Returns the project just edited.

Response Example (200 OK)
{
  "maximum_loan_amount": "number",
  "amount_min": "number",
  "vote_score": "integer",
  "owner": "string",
  "facebook": "string",
  "currency": "string",
  "duration": "integer",
  "linkedin": "string",
  "location_coordinates": "string",
  "wallet": "string",
  "minimum_loan_amount": "number",
  "short_project_description": "string",
  "website": "string",
  "request_type": "string",
  "num_vote_up": "integer",
  "rate_interest": "number",
  "campaign_end_date": "string",
  "num_vote_down": "integer",
  "amount": "number",
  "id": "integer",
  "tags": "string",
  "disabled": "boolean",
  "title": "string",
  "twitter": "string",
  "user_wallet": "string",
  "card_picture": "string",
  "project_description": "string",
  "project_contact_email": "string",
  "process_id": "string",
  "brand": "string",
  "reimbursement": "string",
  "commission": "number",
  "location": "string"
}

Disable a project

DELETE /v1/projects/{id}/

Disable a project

id

(no description)

type
string
in
path
204 No Content

The project has been correctly disabled.

Close a project

POST /v1/projects/{id}/close

Close a project when all the contract are signed or the needed administrative tasks performed.

id

(no description)

type
string
in
path
201 Created

List contributions

GET /v1/projects/{id}/contribution/

List contributions of the given project. The results are paginated and wrapped in a JSON object with 'count' and 'results' properties. The page length is 25.

id

(no description)

type
string
in
path
page

A page number within the paginated result set.

type
integer
in
query
200 OK

Returns the contributions.

Response Example (200 OK)
{
  "rewards": [
    "string"
  ],
  "project": "string",
  "disabled": "boolean",
  "user": "string",
  "amount": "number",
  "id": "integer",
  "currency": "string",
  "transaction": "string",
  "user_wallet": "string",
  "submit_date": "string"
}

Create a new contribution

POST /v1/projects/{id}/contribution/

Create a new contribution for the given project.

amount: number
rewards: string[]

The list (with no repetitions) of ID of rewards claimed for this contribution.

currency: string

Default: CHF

disabled: boolean

Set to True if the contribution has been cancelled. The only possible cause is a failure of the transaction. The claimed rewards are not deducted for cancelled contributions.

user_wallet: string

The ID of the wallet providing the money.

id

(no description)

type
string
in
path
Request Example
{
  "amount": "number",
  "rewards": [
    "string"
  ],
  "currency": "string",
  "disabled": "boolean",
  "user_wallet": "string"
}
201 Created

Returns the contribution just created.

Response Example (201 Created)
{
  "rewards": [
    "string"
  ],
  "project": "string",
  "disabled": "boolean",
  "user": "string",
  "amount": "number",
  "id": "integer",
  "currency": "string",
  "transaction": "string",
  "user_wallet": "string",
  "submit_date": "string"
}

Get a contribution

GET /v1/projects/{id}/contribution/{cb_id}/

Get a contribution

id

(no description)

type
string
in
path
cb_id

(no description)

type
string
in
path
200 OK

Returns the contribution.

Response Example (200 OK)
{
  "rewards": [
    "string"
  ],
  "project": "string",
  "disabled": "boolean",
  "user": "string",
  "amount": "number",
  "id": "integer",
  "currency": "string",
  "transaction": "string",
  "user_wallet": "string",
  "submit_date": "string"
}

Update a contribution

PUT /v1/projects/{id}/contribution/{cb_id}/

Update a contribution

amount: number
rewards: string[]

The list (with no repetitions) of ID of rewards claimed for this contribution.

currency: string

Default: CHF

disabled: boolean

Set to True if the contribution has been cancelled. The only possible cause is a failure of the transaction. The claimed rewards are not deducted for cancelled contributions.

user_wallet: string

The ID of the wallet providing the money.

id

(no description)

type
string
in
path
cb_id

(no description)

type
string
in
path
Request Example
{
  "amount": "number",
  "rewards": [
    "string"
  ],
  "currency": "string",
  "disabled": "boolean",
  "user_wallet": "string"
}
200 OK

Returns the contribution just edited.

Response Example (200 OK)
{
  "rewards": [
    "string"
  ],
  "project": "string",
  "disabled": "boolean",
  "user": "string",
  "amount": "number",
  "id": "integer",
  "currency": "string",
  "transaction": "string",
  "user_wallet": "string",
  "submit_date": "string"
}

Validate a project

POST /v1/projects/{id}/initialize

Validate a project when the user has provided all the information and has a KYC2 wallet.

id

(no description)

type
string
in
path
201 Created

Start a campaign

POST /v1/projects/{id}/launch

Start a campaign on an initialized project, when the project wallet is in KYC2 status too.

id

(no description)

type
string
in
path
201 Created

List the rewards

GET /v1/projects/{id}/reward/

List the rewards of the given project.

id

(no description)

type
string
in
path
all

If set to 'true', lists also disabled rewards (Optional).

type
string
in
query
200 OK

Returns the rewards.

Response Example (200 OK)
{
  "amount_min": "number",
  "project": "string",
  "create_timestamp": "string",
  "id": "integer",
  "last_edit_timestamp": "string",
  "disabled": "boolean",
  "description": "string",
  "number_claimed": "string",
  "name": "string",
  "number_max": "integer",
  "available_to": "string",
  "amount_max": "number",
  "available_from": "string"
}

Create a new reward

POST /v1/projects/{id}/reward/

Create a new reward for the given project.

amount_min: number
available_from: string

Date and time before which this reward cannot be claimed.

available_to: string

Date and time after which this reward cannot be claimed.

name: string
amount_max: number

In the case the maximum is not defined, there is no upper limit.

number_max: integer

Default: 999

description: string

Summarize the reward for this stage. (max. 280 char.)

id

(no description)

type
string
in
path
Request Example
{
  "amount_min": "number",
  "available_from": "string",
  "available_to": "string",
  "name": "string",
  "amount_max": "number",
  "number_max": "integer",
  "description": "string"
}
201 Created

Returns the reward just created.

Response Example (201 Created)
{
  "amount_min": "number",
  "project": "string",
  "create_timestamp": "string",
  "id": "integer",
  "last_edit_timestamp": "string",
  "disabled": "boolean",
  "description": "string",
  "number_claimed": "string",
  "name": "string",
  "number_max": "integer",
  "available_to": "string",
  "amount_max": "number",
  "available_from": "string"
}

Get a reward

GET /v1/projects/{id}/reward/{cp_id}/

Get a reward

id

(no description)

type
string
in
path
cp_id

(no description)

type
string
in
path
200 OK

Returns the reward.

Response Example (200 OK)
{
  "amount_min": "number",
  "project": "string",
  "create_timestamp": "string",
  "id": "integer",
  "last_edit_timestamp": "string",
  "disabled": "boolean",
  "description": "string",
  "number_claimed": "string",
  "name": "string",
  "number_max": "integer",
  "available_to": "string",
  "amount_max": "number",
  "available_from": "string"
}

Update a reward

PUT /v1/projects/{id}/reward/{cp_id}/

Update a reward

amount_min: number
available_from: string

Date and time before which this reward cannot be claimed.

available_to: string

Date and time after which this reward cannot be claimed.

name: string
amount_max: number

In the case the maximum is not defined, there is no upper limit.

number_max: integer

Default: 999

description: string

Summarize the reward for this stage. (max. 280 char.)

id

(no description)

type
string
in
path
cp_id

(no description)

type
string
in
path
Request Example
{
  "amount_min": "number",
  "available_from": "string",
  "available_to": "string",
  "name": "string",
  "amount_max": "number",
  "number_max": "integer",
  "description": "string"
}
200 OK

Returns the reward just edited.

Response Example (200 OK)
{
  "amount_min": "number",
  "project": "string",
  "create_timestamp": "string",
  "id": "integer",
  "last_edit_timestamp": "string",
  "disabled": "boolean",
  "description": "string",
  "number_claimed": "string",
  "name": "string",
  "number_max": "integer",
  "available_to": "string",
  "amount_max": "number",
  "available_from": "string"
}

Disable a reward

DELETE /v1/projects/{id}/reward/{cp_id}/

Disable a reward

id

(no description)

type
string
in
path
cp_id

(no description)

type
string
in
path
204 No Content

The reward has been correctly disabled.

Terminate a campaign

POST /v1/projects/{id}/terminate

Terminate a campaign when the deadline is passed or prematurely.

id

(no description)

type
string
in
path
201 Created

Add a vote to a project for the current user.

POST /v1/projects/{id}/vote

Add a vote to a project for the current user. Each user can only vote once per project.

vote: string
id

(no description)

type
string
in
path
Request Example
{
  "vote": "string"
}
201 Created

Returns the project just voted.

Remove a vote from a project for the current user.

DELETE /v1/projects/{id}/vote

Remove a vote from a project for the current user.

id

(no description)

type
string
in
path
204 No Content

The project without the user's vote.

users

List users

GET /v1/users/

List users that have allowed the current brand to access their profile. It can contain users and companies (in the latter case, the first name and last name are the company name). The results are paginated and wrapped in a JSON object with 'count' and 'results' properties. The page length is 25.

page

A page number within the paginated result set.

type
integer
in
query
200 OK

Returns the users.

Response Example (200 OK)
{
  "first_name": "string",
  "id": "integer",
  "email": "string",
  "picture": "string",
  "last_name": "string"
}

Get the current user profile

GET /v1/users/myself/

Get the current user profile

200 OK

Returns the current user's profile.

Response Example (200 OK)
{
  "country": "string",
  "date_of_birth": "string",
  "civility": "string",
  "address_extra": "string",
  "last_name": "string",
  "city": "string",
  "first_name": "string",
  "street": "string",
  "street_number": "string",
  "kyc_status": "string",
  "occupation": "string",
  "nationality": "string",
  "metadata": "string",
  "picture": "string",
  "process_id": "string",
  "id": "integer",
  "gender": "string",
  "email": "string",
  "zip_code": "string",
  "mobile_number": "string",
  "user_type": "string"
}

Update the current user profile

PUT /v1/users/myself/

Update the current user profile . If the user is a company, the model may vary.

date_of_birth: string

Format YYYY-MM-dd (e.g.: 1985-12-31)

civility: string

The title MASTER [Maître], is used in French within the scope of some legal professions.

last_name: string

This can include the middle name or multiple last names.

city: string

The city corresponding to the ZIP code.

first_name: string
street: string
street_number: string
mobile_number: string

In international format with country code, starting with "+". It can be used for authorizing payments via SMS.

nationality: string
picture: string

The profile picture. For reading, it returns the url. For writing you need to provide the image base64 encoded, like "data:image/jpg;base64, "

country: string

The domiciliation country, corresponding to the address

zip_code: string
gender: string

H: male, F: female, U: undefined

address_extra: string

for example the building floor or PO Box

occupation: string
email: string

For companies, this must be the company contact e-mail, not a personal one.

Request Example
{
  "date_of_birth": "string",
  "civility": "string",
  "last_name": "string",
  "city": "string",
  "first_name": "string",
  "street": "string",
  "street_number": "string",
  "mobile_number": "string",
  "nationality": "string",
  "picture": "string",
  "country": "string",
  "zip_code": "string",
  "gender": "string",
  "address_extra": "string",
  "occupation": "string",
  "email": "string"
}
200 OK

Returns the current user's profile. If the user is a company, the model may vary.

Response Example (200 OK)
{
  "country": "string",
  "date_of_birth": "string",
  "civility": "string",
  "address_extra": "string",
  "last_name": "string",
  "city": "string",
  "first_name": "string",
  "street": "string",
  "street_number": "string",
  "kyc_status": "string",
  "occupation": "string",
  "nationality": "string",
  "metadata": "string",
  "picture": "string",
  "process_id": "string",
  "id": "integer",
  "gender": "string",
  "email": "string",
  "zip_code": "string",
  "mobile_number": "string",
  "user_type": "string"
}

Get a user profile

GET /v1/users/{id}/

Get a user profile

id

(no description)

type
string
in
path
200 OK

Returns the user's profile.

Response Example (200 OK)
{
  "country": "string",
  "date_of_birth": "string",
  "civility": "string",
  "address_extra": "string",
  "last_name": "string",
  "city": "string",
  "first_name": "string",
  "street": "string",
  "street_number": "string",
  "kyc_status": "string",
  "occupation": "string",
  "nationality": "string",
  "metadata": "string",
  "picture": "string",
  "process_id": "string",
  "id": "integer",
  "gender": "string",
  "email": "string",
  "zip_code": "string",
  "mobile_number": "string",
  "user_type": "string"
}

Update the metadata of a user

PUT /v1/users/{id}/metadata/

Update the metadata of a user

example_data: string
id

(no description)

type
string
in
path
Request Example
{
  "example_data": "string"
}
200 OK

Returns the user's profile with the metadata.

Response Example (200 OK)
{
  "country": "string",
  "date_of_birth": "string",
  "civility": "string",
  "address_extra": "string",
  "last_name": "string",
  "city": "string",
  "first_name": "string",
  "street": "string",
  "street_number": "string",
  "kyc_status": "string",
  "occupation": "string",
  "nationality": "string",
  "metadata": "string",
  "picture": "string",
  "process_id": "string",
  "id": "integer",
  "gender": "string",
  "email": "string",
  "zip_code": "string",
  "mobile_number": "string",
  "user_type": "string"
}

wallets

List the wallets

GET /v1/wallets/

List the wallets of the curent user.

kind

Filter only wallets of a given kind (Optional). Possible values depend on your contract.

type
string
in
query
200 OK

Returns the wallets.

Response Example (200 OK)
{
  "data": "string"
}

Creates a new wallet

POST /v1/wallets/

Creates a new wallet for the current user.

currency: string
kind

Defines the kind of wallet to create. Possible values depend on your contract.

type
string
in
query
Request Example
{
  "currency": "string"
}
201 Created

Returns the wallet just created.

Response Example (201 Created)
{
  "data": "string"
}

List transactions

GET /v1/wallets/transaction/

List transactions where the debited or credited wallet belongs to the current user.

200 OK

Get a transaction

GET /v1/wallets/transaction/{id}/

Get a transaction for the current user.

id

(no description)

type
string
in
path
200 OK

Returns the transaction.

Response Example (200 OK)
{
  "create_timestamp": "string",
  "reason": "string",
  "id": "integer",
  "currency": "string",
  "last_edit_timestamp": "string",
  "process": "integer",
  "user": "string",
  "debited_wallet": "string",
  "backend_fees": "number",
  "extra_info": "string",
  "scheduled_execution_date": "string",
  "amount": "number",
  "credited_wallet": "string",
  "method": "string"
}

Get a wallet

GET /v1/wallets/{id}/

Get a wallet for the current user.

id

(no description)

type
string
in
path
200 OK

Returns the wallet.

Response Example (200 OK)
{
  "data": "string"
}

Load a wallet

POST /v1/wallets/{id}/load

Load a wallet . Initiate a loading process for the given walet. This may not be applicable to all kind of wallets.

amount: number
method: integer

0: direct, 1: SOFORT

id

(no description)

type
string
in
path
Request Example
{
  "amount": "number",
  "method": "integer"
}
201 Created

Returns the transaction details of the loading process.

Response Example (201 Created)
{
  "create_timestamp": "string",
  "reason": "string",
  "id": "integer",
  "currency": "string",
  "last_edit_timestamp": "string",
  "process": "integer",
  "user": "string",
  "debited_wallet": "string",
  "backend_fees": "number",
  "extra_info": "string",
  "scheduled_execution_date": "string",
  "amount": "number",
  "credited_wallet": "string",
  "method": "string"
}

Withdraw from a wallet

POST /v1/wallets/{id}/unload

Withdraw from a wallet . Initiate the withdrawing process from the given walet. This may not be applicable to all kind of wallets.

amount: number
method: integer

0: direct, 1: SOFORT

id

(no description)

type
string
in
path
Request Example
{
  "amount": "number",
  "method": "integer"
}
201 Created

Returns the transaction details of the withdrawing process.

Response Example (201 Created)
{
  "create_timestamp": "string",
  "reason": "string",
  "id": "integer",
  "currency": "string",
  "last_edit_timestamp": "string",
  "process": "integer",
  "user": "string",
  "debited_wallet": "string",
  "backend_fees": "number",
  "extra_info": "string",
  "scheduled_execution_date": "string",
  "amount": "number",
  "credited_wallet": "string",
  "method": "string"
}

Schema Definitions

Brand: object

A brand is a product of a user or a company that implements a front-end to the WeCan.Fund API. It is typically a web site, but could also be a mobile application or a desktop one.

name: string

The name of the brand

owner: integer

The ID of the user or company that can manage the brand.

url: string

The URL of the home page of the front-end of the brand.

Example
{
  "name": "string",
  "owner": "integer",
  "url": "string"
}

User: object

Represents a physical user.

id: integer

ID

first_name: string

First Name

last_name: string

Last Name: This can include the middle name or multiple last names.

email: string

Email address: For companies, this must be the company contact e-mail, not a personal one.

civility: string , x ∈ { MR , MLLE , MM , PROF , DR , MASTER }

Title: The title MASTER [Maître], is used in French within the scope of some legal professions.

gender: string , x ∈ { H , F , U }

H: male, F: female, U: undefined

street: string

Street name

street_number: string
address_extra: string

Address line 2: for example the building floor or PO Box

zip_code: string

ZIP Code

city: string

The city corresponding to the ZIP code.

country: string

The domiciliation country, corresponding to the address

nationality: string[]
occupation: string

Profession

picture: string

The profile picture. For reading, it returns the url. For writing you need to provide the image base64 encoded, like "data:image/jpg;base64, "

date_of_birth: string (date)

Birthdate: Format YYYY-MM-dd (e.g.: 1985-12-31)

mobile_number: string

In international format with country code, starting with "+". It can be used for authorizing payments via SMS.

user_type: string

The type of user: can be empty for normal users, brandadmin for the owner of the current brand, wcfadm for the WeCan.Fund staff

kyc_status: string

KYC status: (Know Your Customer), possible values are Registered [the user just registered to the platform], WCFValidated [the user validated its e-mail/mobile phone number], WCFKYC1 [the user provided enough information to create a wallet]

metadata: string

MetaData: You can use this field to store any metadata you want about this user, in the JSON format. Your metadata is only accessible by your brand. To edit this data, you have to use the dedicated API endpoint.

process_id: string

KYC process id: The id of the process reflecting the user's KYC

Example
{
  "id": "integer",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "civility": "string",
  "gender": "string",
  "street": "string",
  "street_number": "string",
  "address_extra": "string",
  "zip_code": "string",
  "city": "string",
  "country": "string",
  "nationality": [
    "string"
  ],
  "occupation": "string",
  "picture": "string",
  "date_of_birth": "string (date)",
  "mobile_number": "string",
  "user_type": "string",
  "kyc_status": "string",
  "metadata": "string",
  "process_id": "string"
}

Company: object

Represents a company or organisation. They can act interchangeably like normal users, login and have their own wallets. A company has a list of managers who are physical users that can act on behalf of the company, but this is managed by the backend.

id: integer

ID

email: string

Email address: For companies, this must be the company contact e-mail, not a personal one.

company_name: string

Name of the company

subsidiary_name: string

Subsidiary name: (when applicable)

company_identification_number: string

Company identification number (Companies House)

street: string

Street name

street_number: string
address_extra: string

Address line 2: for example the building floor or PO Box

zip_code: string

ZIP Code

city: string

The city corresponding to the ZIP code.

country: string

The domiciliation country, corresponding to the address

company_description: string

Description of the goals and activities of the company.

principal_activity_sector: string

According to the European NACE database level 1 or 2 ( http://ec.europa.eu/competition/mergers/cases/index/nace_all.html)

company_website: string

Web site's URL

company_creation_date: string (date)

Format YYYY-MM-dd (e.g.: 1985-12-31)

legal_status: string , x ∈ { SA , SARL , ONG }

SA: Incorporation, SARL: Limited liability company, ONG: Non-governmental organization

representatives: string

Representative person(s): Comma-separated list of the names of the company representatives, not to be confused with the managers who can actually login on behalf of the company.

picture: string

The profile picture. For reading, it returns the url. For writing you need to provide the image base64 encoded, like "data:image/jpg;base64, "

user_type: string

The type of user: can be empty for normal users, brandadmin for the owner of the current brand, wcfadm for the WeCan.Fund staff

kyc_status: string

KYC status of the company: (Know Your Customer), possible values are Registered [the company just registered to the platform], WCFValidated [the company validated its e-mail/mobile phone number], WCFKYC1 [the company provided enough information to create a wallet]

metadata: string

MetaData: You can use this field to store any metadata you want about this user, in the JSON format. Your metadata is only accessible by your brand. To edit this data, you have to use the dedicated API endpoint.

process_id: string

KYC process id: The id of the process reflecting the company's KYC

Example
{
  "id": "integer",
  "email": "string",
  "company_name": "string",
  "subsidiary_name": "string",
  "company_identification_number": "string",
  "street": "string",
  "street_number": "string",
  "address_extra": "string",
  "zip_code": "string",
  "city": "string",
  "country": "string",
  "company_description": "string",
  "principal_activity_sector": "string",
  "company_website": "string",
  "company_creation_date": "string (date)",
  "legal_status": "string",
  "representatives": "string",
  "picture": "string",
  "user_type": "string",
  "kyc_status": "string",
  "metadata": "string",
  "process_id": "string"
}

LemonWay Wallet: object

Represents a wallet hosted by LemonWay. Once the wallet is created, none of its fields can be changed.

id: integer

ID

wallet_uid: string

Unique wallet identifier: This identifies uniquely the wallet in the LemonWay backend.

creator: integer

Wallet's creator and owner

create_timestamp: string (date-time)

Date and time when the wallet was created. Format YYYY-MM-dd (e.g.: 1985-12-31)

currency: string , x ∈ { CHF , EUR , USD }

Wallet's currency: It is not possible currently to convert currencies and transfer money between wallets of different currencies.

is_tech_wallet: string , x ∈ { 1 , 0 }

This wallet is a technical wallet: Technical wallets are used as escrow account only, during a funding campaign.

backend: string

The wallet backend.

process_id: string

Lemonway KYC process id: The id of the process reflecting the Lemonway wallet's KYC

load_infos: object[]
Example
{
  "id": "integer",
  "wallet_uid": "string",
  "creator": "integer",
  "create_timestamp": "string (date-time)",
  "currency": "string",
  "is_tech_wallet": "string",
  "backend": "string",
  "process_id": "string",
  "load_infos": [
    "object"
  ]
}

Dummy Wallet: object

This is a wallet based on a dummy backend, for testing purpose only. It doesn't reflect any real money! It may be reset at any time.

id: integer

ID

create_timestamp: string (date-time)

Date and time when the wallet was created.

backend: string

The wallet backend.

load_infos: object[]
currency: string , x ∈ { CHF , EUR , USD }

Wallet's currency: It is not possible currently to convert currencies and transfer money between wallets of different currencies.

is_tech_wallet: string , x ∈ { 1 , 0 }

This wallet is a technical wallet: Technical wallets are used as escrow account only, during a funding campaign.

amount: number (float)

Amount in the wallet

creator: integer

Wallet's creator and owner

Example
{
  "id": "integer",
  "create_timestamp": "string (date-time)",
  "backend": "string",
  "load_infos": [
    "object"
  ],
  "currency": "string",
  "is_tech_wallet": "string",
  "amount": "number (float)",
  "creator": "integer"
}

Transaction: object

Represents a transaction from and/or to a wallet. A transaction cannot be edited.

id: integer

ID

process: integer

The ID of the process corresponding to this transaction.

amount: number (float)

Amount of the transaction

currency: string , x ∈ { CHF , EUR , USD }

Currency of the transaction

backend_fees: number (float)

Fees: Fees are defined per brand and specified in your contract. This field aggregates all fees applied to this transaction. They are expressed in the same currency as the transaction.

scheduled_execution_date: string (date)

Scheduled date of execution

create_timestamp: string (date-time)

Creation date and time

last_edit_timestamp: string (date-time)

Last edited date and time

method: string , x ∈ { 0 , 1 , 102 }

Transfer method: Currently supported methods are 0: Wallet to wallet transfer (on the same backend), 1: SOFORT Banking for money in, 102: Bank wire transfer.

extra_info: string

Additional information about the transfer

reason: string , x ∈ { MONEY-IN , MONEY-OUT , CONTRIBUTION , REIMBURSEMENT , FEES , RELEASE , REPAYEMENT }

Reason for the transaction

debited_wallet: integer

ID of the wallet debited, leave empty for money in.

credited_wallet: integer

ID of the wallet credited, leave empty for money out.

user: integer

The user who triggered the transaction.

Example
{
  "id": "integer",
  "process": "integer",
  "amount": "number (float)",
  "currency": "string",
  "backend_fees": "number (float)",
  "scheduled_execution_date": "string (date)",
  "create_timestamp": "string (date-time)",
  "last_edit_timestamp": "string (date-time)",
  "method": "string",
  "extra_info": "string",
  "reason": "string",
  "debited_wallet": "integer",
  "credited_wallet": "integer",
  "user": "integer"
}

Project: object

A project represents a fundraising campaign. Project can collect votes. Each user as a single vote per project. You can choose to also use the downvoting system.

id: integer

ID

tags: string[]

List of tags for this project. You can use any string for this and you can use the List tags endpoint if you want to provide some autofill to the user, based on the previously seen tags for this brand. You can also choose to restrict the tags to your own list.

vote_score: integer

Total number of votes for this project (up votes - down votes).

num_vote_up: integer

Number of up votes for this project.

num_vote_down: integer

Number of down votes for this project.

card_picture: string

The picture for the project. For reading, it returns the url. For writing you need to provide the image base64 encoded, like "data:image/jpg;base64, ". Minimum size 560x420px, but it can be any size larger than this as long as the ratio is preserved. Images with another ratio may be crop when displayed on aggregators.

location_coordinates: string

The location of the project, as geographic coordinates. E.g.: {"longitude": 6.565554141998291, "latitude"=46.52027836093017}

process_id: string

Project process id: The id of the process reflecting the state of the project.

title: string

Project title: Max 60 char.

request_type: string , x ∈ { FUNDING , LENDING , DONATION }

Type of request: FUNDING (default option): Crowdfunding (in kind rewards), LENDING: Crowdlending (refund and interests), DONATION: Donation (no direct rewards)

amount: number (float)

The target of the fundraising (minimum and default: 30'000). In the case of a crowdlending, this is also the maximum amount that can be collected.

amount_min: number (float)

Minimal amount: The minimal amount to succeed the project. (default: 0)

minimum_loan_amount: number (float)

Minimum amount per contribution transaction

maximum_loan_amount: number (float)

Maximum amount per contribution transaction

currency: string , x ∈ { CHF , EUR , USD }

default: CHF

rate_interest: number (float)

Annual interest rate: Expressed in percent. Only applicable in the case of a LENDING project. Default: 0

reimbursement: string , x ∈ { MONTHLY , QUARTERLY , ONCE , MANUALLY }

Reimburse strategy: How should the loan (and interests) be reimbursed: do nothing, all at the end, or split in equal parts monthly or every three months (in this case the duration must be a multiple of 3). The default option is to do nothing, it must then be triggered through the dedicated API calls. Only used in the case of a LENDING project.

commission: number (float)

Fees: Fees of the brand, taken on the collected funds if the project succeeds. This is expressed as a percentage. Default: 0

duration: integer

Duration of the loan: Number of months from the closing of the project until full refund of the lenders. This only applies to LENDING projects. Default: 3

campaign_end_date: string (date-time)

Deadline for the fundraising: Date at which the project automatically closes and switches to success or failure, depending on the amount collected.

short_project_description: string

Brief description of the project (max. 280 char.)

project_description: string

Description of the project: Expected format is HTML, ideally domain independant in terms of styles and media.

website: string

Project's website

linkedin: string

Project's LinkedIn profile

facebook: string

Project's Facebook page

twitter: string

Project's Twitter page

project_contact_email: string

Contact e-mail address for this project.

disabled: boolean

Set to True if a project is deleted. It is not possible to un-delete, but a deleted project can still be retrieved for information.

location: string

The location of the project, as a place name.

owner: integer

The owner of the project, who receives the money if it succeeds. It can be a user or a company.

wallet: integer

ID of the technical wallet linked to this project.

user_wallet: integer

ID of the project owner's wallet.

brand: integer

ID of the brand which created this project.

Example
{
  "id": "integer",
  "tags": [
    "string"
  ],
  "vote_score": "integer",
  "num_vote_up": "integer",
  "num_vote_down": "integer",
  "card_picture": "string",
  "location_coordinates": "string",
  "process_id": "string",
  "title": "string",
  "request_type": "string",
  "amount": "number (float)",
  "amount_min": "number (float)",
  "minimum_loan_amount": "number (float)",
  "maximum_loan_amount": "number (float)",
  "currency": "string",
  "rate_interest": "number (float)",
  "reimbursement": "string",
  "commission": "number (float)",
  "duration": "integer",
  "campaign_end_date": "string (date-time)",
  "short_project_description": "string",
  "project_description": "string",
  "website": "string",
  "linkedin": "string",
  "facebook": "string",
  "twitter": "string",
  "project_contact_email": "string",
  "disabled": "boolean",
  "location": "string",
  "owner": "integer",
  "wallet": "integer",
  "user_wallet": "integer",
  "brand": "integer"
}

Contribution: object

A contribution is characterized by a user participating in a project's campaign with a certain amount of money. A transaction from a user's (or company's) wallet to the technical wallet of the project is initiated. A list of rewards can be associated (rewards cannot be repeated). When a reward is specified in the submission of the contribution, it is first validated against its constraints (amount, quantity, timeframe). Once submitted a contribution cannot be edited.

id: integer

ID

amount: number (float)

Amount contributed

currency: string , x ∈ { CHF , EUR , USD }

Default: CHF

submit_date: string (date-time)

Date and time at which the contribution has been received and the transaction started.

disabled: boolean

Set to True if the contribution has been cancelled. The only possible cause is a failure of the transaction. The claimed rewards are not deducted for cancelled contributions.

user: integer

ID of the user contributing.

project: integer

ID of the project receiving the money.

user_wallet: integer

The ID of the wallet providing the money.

transaction: integer

The ID of the transaction.

rewards: integer[]

The list (with no repetitions) of ID of rewards claimed for this contribution.

Example
{
  "id": "integer",
  "amount": "number (float)",
  "currency": "string",
  "submit_date": "string (date-time)",
  "disabled": "boolean",
  "user": "integer",
  "project": "integer",
  "user_wallet": "integer",
  "transaction": "integer",
  "rewards": [
    "integer"
  ]
}

Reward: object

A reward is characterized by the project it is linked to and the minimum (potentially also maximum) amount contributed required to claim it. It has also some additional constraints that are checked when a user claims a reward, such as the quantity and the timespan.

id: integer

ID

project: integer

ID of the project.

amount_min: number (float)

Minimum Amount

amount_max: number (float)

Maximum Amount: In the case the maximum is not defined, there is no upper limit.

name: string

Reward name, max. 20 char.

description: string

Reward description: Summarize the reward for this stage. (max. 280 char.)

available_from: string (date-time)

Date and time before which this reward cannot be claimed.

available_to: string (date-time)

Date and time after which this reward cannot be claimed.

number_max: integer

Maximum quantity available: Default: 999

create_timestamp: string (date-time)

Date and time when the reward was created.

last_edit_timestamp: string (date-time)

Date and time when the reward was edited.

disabled: boolean

Set to True if a reward is deleted. It is not possible to un-delete, but a deleted reward can still be retrieved for information. Only un-claimed rewards can be deleted.

number_claimed: string
Example
{
  "id": "integer",
  "project": "integer",
  "amount_min": "number (float)",
  "amount_max": "number (float)",
  "name": "string",
  "description": "string",
  "available_from": "string (date-time)",
  "available_to": "string (date-time)",
  "number_max": "integer",
  "create_timestamp": "string (date-time)",
  "last_edit_timestamp": "string (date-time)",
  "disabled": "boolean",
  "number_claimed": "string"
}

Process: object

The actual fields depend on the specific process. Below are the common ones.

id: integer

ID

display_name: string

The name of the process.

status: string , x ∈ { waiting , inprogress , done , deleted }

The status of the process.

status_display: string

The verbose status of the process.

started_date: string (date-time)

The date and time when the process was started.

ended_date: string (date-time)

The date and time when the process was finished.

current_step: string

The key of the current step.

steps: object[]

The list of steps of this project, see the Process step object for more details.

Example
{
  "id": "integer",
  "display_name": "string",
  "status": "string",
  "status_display": "string",
  "started_date": "string (date-time)",
  "ended_date": "string (date-time)",
  "current_step": "string",
  "steps": [
    "object"
  ]
}

Process step: object

A step of a process. The actual fields depend on the specific process and steps. Below are the common ones.

id: integer

ID

key: string

The key of this step. Keys are unique per process.

next_steps: string[]

The list of keys of the steps following this one.

details: string

Detailled description of the step.

ended_date: string (date-time)

The date and time when the step was left.

started_date: string (date-time)

The date and time when the step was entered.

status: string , x ∈ { waiting , inprogress , done , deleted }

The status of the step.

status_display: string

The verbose status of the step.

Example
{
  "id": "integer",
  "key": "string",
  "next_steps": [
    "string"
  ],
  "details": "string",
  "ended_date": "string (date-time)",
  "started_date": "string (date-time)",
  "status": "string",
  "status_display": "string"
}

Notification: object

The notifications are messages created by the backend when a certain event happens that would require the users' attention. The brands cannot create directly notifications, but they are generated indirectly through their interractions with the backend.

id: integer

ID

key: string

A key for classifying notifications that are about the same kind of event.

species: string

Species are a way to group notifications that need the same treatment, like the same display template.

creation_date: string (date-time)

The date and time when the notification was created.

seen_date: string (date-time)

The date and time when the notification was actually seen.

seen: boolean

If the notification is marked as read. It is still possible that it hasn't been actually read by the user, but just muted.

destination_link: string

A link to the object or event log that caused the notification.

brand: integer

The brand that generated the notification.

public: boolean

Indicate that all brands have access to the notification

metadata: string

Additional information stored in JSON.

Example
{
  "id": "integer",
  "key": "string",
  "species": "string",
  "creation_date": "string (date-time)",
  "seen_date": "string (date-time)",
  "seen": "boolean",
  "destination_link": "string",
  "brand": "integer",
  "public": "boolean",
  "metadata": "string"
}

Document: object

A document corresponds to a single file linked to a user or a project. The different types of document are detailled below.

id: integer

ID

type: integer

The ID of the document type. It can be an internal type or a custom one.

filename: string

The name of the file as it was when uploaded.

creation_date: string (date-time)

The date and time when the file was uploaded.

linked_type: string

The type of object linked to this document: (currently limited to user or project)

type_id: string

The id of object linked to this document

Example
{
  "id": "integer",
  "type": "integer",
  "filename": "string",
  "creation_date": "string (date-time)",
  "linked_type": "string",
  "type_id": "string"
}

Internal document type: object

These types of document are predefined and correspond, among others, to administrative documents needed for the KYC process of the users.

id: integer

ID

title: string

The name of the document type

description: string

The description of the document type

disabled: boolean

Set to True for disabling a document type, so that it cannot be used for future document uploads.

key: string

A unique key for refering to this document type.

type: string

Always equals to 'internal'

linkable_types: string

The list of object types that can be linked to this document. For example 'user' or 'project'.

Example
{
  "id": "integer",
  "title": "string",
  "description": "string",
  "disabled": "boolean",
  "key": "string",
  "type": "string",
  "linkable_types": "string"
}

Custom document type: object

These types of documents are defined by the brand for its own needs, typically they can be extra documents about the user, or about a project. They allow the brands to delegate the storage of documents to the WeCan.Fund backend and for the user to see all his documents centrally.

id: integer

ID

disabled: boolean

Set to True for disabling a document type, so that it cannot be used for future document uploads.

title: string

The name of the document type

description: string

The description of the document type

key: string

A unique to the brand key for refering to this document type.

metadata: string

Additional information stored in JSON.

type: string

Always equals to 'custom'

Example
{
  "id": "integer",
  "disabled": "boolean",
  "title": "string",
  "description": "string",
  "key": "string",
  "metadata": "string",
  "type": "string"
}

Error: object

This object is returned in case of a server error with your request. If the error is due to a malformed request content, for example missing a required field, the details may contain a JSON object detailling the input validation results.

status_code: string

The HTTP error code

details: string

The detailled error message or a JSON object. For example when submitting an object, it can detail for each field if there was an error.

Example
{
  "status_code": "string",
  "details": "string"
}