# Nyala Tokenization API

Version: v1

## Servers

Production Environment
```
https://vault.nyala.de
```

UAT / Sandbox Environment
```
https://uat.vault.nyala.de
```

## Security

### ApiKey

API Key header. Example: "X-API-KEY: {key}"

Type: apiKey
In: header
Name: X-API-KEY

## Download OpenAPI description

[Nyala Tokenization API](https://nyala-docs.redocly.app/_bundle/apis/tokenization.yaml)

## Project

### Retrieves a list of projects by institution ID.

 - [GET /api/Project/{institutionId}](https://nyala-docs.redocly.app/apis/tokenization/project/getprojectsbyinstitutionid.md)

### Creates a new project.

 - [POST /api/Project/{institutionId}](https://nyala-docs.redocly.app/apis/tokenization/project/createproject.md)

### Updates a project.

 - [PUT /api/Project/{institutionId}](https://nyala-docs.redocly.app/apis/tokenization/project/updateproject.md)

### Get Project OptIns.

 - [GET /api/Project/{institutionId}/{projectId}/optins](https://nyala-docs.redocly.app/apis/tokenization/project/getprojectoptins.md)

### Downloads the registry extract for a project.

 - [GET /api/Project/{institutionId}/{projectId}/registry-extract](https://nyala-docs.redocly.app/apis/tokenization/project/downloadregistryextract.md)

### Get Project Transfers.

 - [GET /api/Project/{institutionId}/{projectId}/transfers](https://nyala-docs.redocly.app/apis/tokenization/project/getprojecttransfers.md)

### V2 Enqueue a task to start the registry extract generation for a specified project and institution.

 - [POST /api/Project/{institutionId}/{projectId}/registry-extract-v2](https://nyala-docs.redocly.app/apis/tokenization/project/generateregistryextractv2.md)

## Tokenization

### Create a mint token request.

 - [POST /api/Tokenization/{institutionId}/mint-token-request](https://nyala-docs.redocly.app/apis/tokenization/tokenization/createminttokenrequest.md)

### Returns details about the given tokenized asset. Details include transfers, open opt-in requests and.

 - [GET /api/Tokenization/{institutionId}/tokenized-assets/{tokenized-asset-id}](https://nyala-docs.redocly.app/apis/tokenization/tokenization/gettokenizedassetdetails.md)

### Finalized tokenized asset creation.

 - [PUT /api/Tokenization/{institutionId}/tokenized-assets/{tokenized-asset-id}](https://nyala-docs.redocly.app/apis/tokenization/tokenization/finalizetokenizedasset.md)

### Returns tokenized asset by unit name.

 - [GET /api/Tokenization/{institutionId}/tokenized-assets/unit/{tokenized-asset-unit-name}](https://nyala-docs.redocly.app/apis/tokenization/tokenization/gettokenizedassetbyunitname.md)

### Sends the token metadata on chain for the given institutional ID and tokenized asset ID.

 - [POST /api/Tokenization/{institutionId}/tokenized-asset/{tokenizedAssetId}/send-token-metadata-on-chain](https://nyala-docs.redocly.app/apis/tokenization/tokenization/sendtokenmetadataonchain.md)

### Initialize tokenized asset creation.

 - [POST /api/Tokenization/{institutionId}/tokenized-assets](https://nyala-docs.redocly.app/apis/tokenization/tokenization/initializetokenizedassetcreation.md)

### Retrieves the unique address of a token based on its deployment conditions - Just for Polygon Tokens.

 - [POST /api/Tokenization/{institutionId}/tokenized-assets/{tokenized-asset-id}/get-set-token-address](https://nyala-docs.redocly.app/apis/tokenization/tokenization/getsettokenaddress.md)

### Send asset class tokenized assets to retail wallets.
Returns a list of transfer ids.

 - [POST /api/Tokenization/{institutionId}/tokenized-assets/{tokenized-asset-id}/transfer-asset-class](https://nyala-docs.redocly.app/apis/tokenization/tokenization/transferassetclasstokenizedassets.md)

### Initiate transfer for approved for delivery asset class optins.

 - [POST /api/Tokenization/{institutionId}/tokenized-assets/{tokenized-asset-id}/transfer-asset-class-afd](https://nyala-docs.redocly.app/apis/tokenization/tokenization/transferafdassetclasstokenizedassets.md)

### Upload Terms of Issuance file.

 - [PATCH /api/Tokenization/tokenized-asset/{tokenizedAssetId}](https://nyala-docs.redocly.app/apis/tokenization/tokenization/updatetokenizedasset.md)

### Approves the creation of a tokenized asset.

 - [PUT /api/Tokenization/{institutionId}/tokenized-assets/{tokenizedAssetId}/approve](https://nyala-docs.redocly.app/apis/tokenization/tokenization/approvetokenizedassetcreation.md)

## Transaction

### Retrieves a paginated list of transactions based on the given query parameters.

 - [POST /api/Transaction/institutionId/{institutionId}](https://nyala-docs.redocly.app/apis/tokenization/transaction/gettransactions.md)