Creates a new project.

Request

Security

ApiKey

Path

institutionIdstring, (uuid)required

The identifier of the institution.

Body

The project data.

namestring, [ 1 .. 100 ] charactersrequired

institutionIdstring, (uuid), non-emptyrequired

userIdstring or null, (uuid)

startOfSubscriptionstring or null

Optional for Share Token Projects. (YYYY-MM-DD)

endOfSubscriptionstring or null

Optional for Share Token Projects. (YYYY-MM-DD)

targetIssuanceDatestring or null

Optional for Share Token Projects. (YYYY-MM-DD)

dueDateOfPaymentsstring or null

Optional. (YYYY-MM-DD)

terminationRightsstring or null

Required for Bond Token Projects ('yes'/'no')

issueSizestring, non-empty(?=^\d+$)(?=^\d+$)

A number in string format.

currencystring or null

Allowed values: 'EUR' / 'CHF'. Default currency is EUR.

Enum:"None""CHF""EUR""USD"

entryTypestring, non-emptyrequired

Enum:"Collective""Individual"

tokenTypestring, non-emptyrequired

Enum:"Bond""Share"

statusstring or null

Enum:"Initiated""Live""InProgress""Active""Finished""Terminated""ActionNeeded"

blockchainstring, non-emptyrequired

Allowed values: 'Polygon', 'Stellar' OR 3 (Stellar), 14 (Polygon).

Enum:"Polygon""Stellar"

projectPassphrasestring, >= 10 characters(?=[A-Z])(?=[a-z])(?=\d)required

Password must be min 10 character and contain at least one uppercase and one lowercase letter

curl -i -X POST \
  'https://vault.nyala.de/api/Project/{institutionId}' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "institutionId": "cdae5c01-a629-4362-be56-52101ec22a49",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "startOfSubscription": "string",
    "endOfSubscription": "string",
    "targetIssuanceDate": "string",
    "dueDateOfPayments": "string",
    "terminationRights": "string",
    "issueSize": "string",
    "currency": "None",
    "entryType": "Collective",
    "tokenType": "Bond",
    "status": "Initiated",
    "blockchain": "Polygon",
    "projectPassphrase": "string"
  }'

Responses

OK

Bodyapplication/json

datastring, (uuid)

errorMessageCodesArray of any or null

Example:null

Response

{
  "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90",
  "errorMessageCodes": null
}