> For the complete documentation index, see [llms.txt](https://akshaypilankar.gitbook.io/mycontract/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://akshaypilankar.gitbook.io/mycontract/client-api/tokenization-platform.md).

# Tokenization platform

## Tokenization platform details

<mark style="color:blue;">`GET`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/details`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

{% tabs %}
{% tab title="200 Cake successfully retrieved." %}

```javascript
{
    "ethBalance": "0.320076509",
    "btcBalance": "0.00000000",
    "projectName": "Demo",
    "userCount": 0,
    "verifiedUserCount": 0,
    "transactionLog": [],
    "tokenBalance": 1000000,
    "crowdsaleBalance": 0
}
```

{% endtab %}

{% tab title="302 Could not find a cake matching this query." %}

```javascript
{
    "status": false,
    "message": "no record found"
}
```

{% endtab %}
{% endtabs %}

## Get tokenization platform site configuration

<mark style="color:blue;">`GET`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/configuration`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

{% tabs %}
{% tab title="200 " %}

```
{
    "status": true,
    "data": {
        "uniqueId": "5d1f9370-2925-11e9-8222-c5291fdb5328",
        "siteName": null,
        "siteLogo": null,
        "coinSymbol": "Dmo",
        "tokenSold": 0,
        "tokenSupply": "1000000",
        "softCap": null,
        "hardCap": null,
        "minimumContribution": null,
        "bonusRate": 0,
        "startDate": null,
        "endDate": null,
        "homeURL": null,
        "aboutusURL": null,
        "contactEmail": null,
        "tokenContractAddress": "0x6d121481Fe9C76BA949b236627CBfB7F8dAb4Aa0",
        "crowdsaleContractAddress": "0xC4c4F5bac9dF6d148b3aCBBFF3389a9c9C006B11",
        "createdAt": "2019-02-05T09:06:46.439Z",
        "updatedAt": "2019-02-05T12:27:59.979Z"
    }
}
```

{% endtab %}

{% tab title="302 " %}

```
{
    "status": false,
    "message": "no record found"
}
```

{% endtab %}
{% endtabs %}

## Update tokenization platform site configuration

<mark style="color:green;">`POST`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/configuration`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

#### Request Body

| Name                | Type   | Description                                |
| ------------------- | ------ | ------------------------------------------ |
| siteLogo            | object | Tokenization platform logo in .PNG         |
| siteName            | string | Tokenization platform name                 |
| softCap             | number | Minimum token sale cap                     |
| hardCap             | number | Maximum token sale cap                     |
| startDate           | string | Initial token offering start time and date |
| endDate             | string | Initial token offering end time and date   |
| homeURL             | string | Landing page URL                           |
| minimumContribution | number | Minimum contribution for token sale        |
| contactEmail        | string | contact email for FAQ and support          |

{% tabs %}
{% tab title="200 " %}

```
{
    "status": true,
    "message": "Project updated successfully!"
}
```

{% endtab %}

{% tab title="302 " %}

```
{
    "status": false,
    "message": "no record found"
}
```

{% endtab %}
{% endtabs %}

## Get pending transactions&#x20;

<mark style="color:blue;">`GET`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/transactions`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

{% tabs %}
{% tab title="200 " %}

```
{
    "status": true,
    "transactionLog": []
}
```

{% endtab %}

{% tab title="302 " %}

```
{
    "status": false,
    "message": "no record found"
}
```

{% endtab %}
{% endtabs %}

## Send token to single user address

<mark style="color:green;">`POST`</mark> `https://api.mycontract.co/v1/tokenization/:tokenName/token/transfer`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

#### Request Body

| Name        | Type   | Description             |
| ----------- | ------ | ----------------------- |
| tokenAmount | number | Token amount            |
| userAddress | string | User's ethereum address |

{% tabs %}
{% tab title="200 " %}

```
{
    "receipt": {
        "blockHash": "0x82e5b2ac5a7812cdad05202f53775fd54165b657c119a50c0aa9c73a24da4a2a",
        "blockNumber": 65,
        "contractAddress": null,
        "cumulativeGasUsed": 49981,
        "from": "0x0c500286a0b60cd518dacd8991d71413f915f403",
        "gasUsed": 49981,
        "logs": [],
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "root": "0xbe510071d9ac9f02a6da2e1f07fa0a6cc36c8130d4de70da53f99c2111d30231",
        "to": "0x6d121481fe9c76ba949b236627cbfb7f8dab4aa0",
        "transactionHash": "0xf004a63118e3f7781eb3bd4f3814265ff24a1094ccfb6137568f2431fda1e76f",
        "transactionIndex": 0
    }
}
```

{% endtab %}

{% tab title="400 " %}

```
{ 
    status: false, 
    message: "network error occured" 
}
```

{% endtab %}
{% endtabs %}

## Complete pending token transaction

<mark style="color:blue;">`GET`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/token/transfer/pending`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT  token  |

#### Request Body

| Name          | Type  | Description                                  |
| ------------- | ----- | -------------------------------------------- |
| transactionId | array | Array of pending token transfer transactions |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Get list of users for provided tokenization platform

<mark style="color:blue;">`GET`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/users/list`

#### Path Parameters

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

{% tabs %}
{% tab title="200 " %}

```
{
    "status": true,
    "data": []
}
```

{% endtab %}

{% tab title="302 " %}

```
{
    "status": false,
    "message": "no record found"
}
```

{% endtab %}
{% endtabs %}

## Get user's account and KYC details

<mark style="color:blue;">`GET`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/user/:id`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string | JWT token   |

{% tabs %}
{% tab title="200 " %}

```
{
        status: true,
        UserData: { data },
}
```

{% endtab %}

{% tab title="302 " %}

```
{ 
    status: false, 
    message: "no data found" 
}
```

{% endtab %}
{% endtabs %}

## Update user's account and KYC status

<mark style="color:green;">`POST`</mark> `https://api.mycontract.co:3001/v1/tokenization/:tokenName/user/:id`

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string |             |

#### Request Body

| Name          | Type    | Description                                           |
| ------------- | ------- | ----------------------------------------------------- |
| kycStatus     | string  | Select from this options ( active, pending, rejected) |
| accountStatus | boolean | User's account status                                 |

{% tabs %}
{% tab title="200 " %}

```
{ 
    status: true, 
    message: "data updated" 
}
```

{% endtab %}

{% tab title="302 " %}

```
{ 
    status: false, 
    message: "error occured" 
}
```

{% endtab %}
{% endtabs %}