Under the German Electronic Securities Act (eWpG), which governs most securities we issue, each investor in a tokenized security must receive a registry extract upon receiving tokens in their wallet. This extract is a one-page PDF document containing essential investment information, including the token name, number of tokens purchased, nominal value (if applicable), and the investor's blockchain wallet address.
You must ensure this document remains accessible to investors at all times, either through a customer portal upload or via email delivery.
To retrieve these extracts via API, first generate them using the following endpoint:
POST Generate registry extract for a specified project and institution /api/Project/{institutionId}/{projectId}/registry-extract
Request Example
# UAT BASE_URL: https://uat.vault.nyala.de
# Production BASE_URL: https://vault.nyala.de
# The {institutionId} is 8c8f78bc-78e0-47a7-b4e0-a793343175f0
# The {projectId} is 40ff9e56-cf2a-499a-9fe7-706e0e136eb7
curl -X POST {{BASE_URL}}/api/Project/{institutionId}/{projectId}/registry-extract \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Response Example
{
"errorMessageCodes": null,
"data": true
}| Parameter | Description |
|---|---|
| institutionID | Your institutionID after having been onboarded on NYALA. InstitutionId is set up in your Postman collection. |
| projectID | The ID of the specific project you want to generate new extracts for. |
Then, you can call the same endpoint to fetch the generated registry extracts. You will need to send the project ID in the payload again.
GET Download the registry extracts for a project /api/Customer/{{institutionId}}/{{customerId}}/registry-extract/{{customerId}}_{{unitName}}.pdf
Request Example
# UAT BASE_URL: https://uat.vault.nyala.de
# Production BASE_URL: https://vault.nyala.de
# {institutionId} = 8c8f78bc-78e0-47a7-b4e0-a793343175f0
# {customerId} = 745f5542-c288-4c49-8284-40cfb69ee52e
# {unitName} = TK6976
curl -X GET {{BASE_URL}}/api/Customer/8c8f78bc-78e0-47a7-b4e0-a793343175f0/745f5542-c288-4c49-8284-40cfb69ee52e/registry-extract/745f5542-c288-4c49-8284-40cfb69ee52e_TK6976.pdf \
-H "X-API-KEY: YOUR_API_KEY"Response Example
%PDF-1.4
1 0 obj
<< /Title (Registry Extract) /Creator (Nyala Digital Systems) >>
... [Binary Data] ...
%%EOF| Parameter | Description |
|---|---|
| institutionID | Your institutionID after having been onboarded on NYALA. InstitutionId is set up in your Postman collection. |
| projectID | The ID of the specific project you want to generate new extracts for. |
The documents will be returned in the field data. You can then send them to your investors however you see fit.