apiary.apib

FORMAT: 1A
HOST: http://token-wallets:3000/

# Jincor Token Wallets Backend

Almost all operations require 2-factor Authentication.
To fulfill this requirement most of them are split to 2 endpoints: first (e.g. /user/login/initiate)
initiates login and generates JWT token. Next this token must be verified using endpoint /user/login/verify.

# Group User

## Register new user [/user]

User's email must be verified after registration. Next step after calling this endpoint is `POST /user/activate` using `verification.id` from response.

### Register new user [POST]

+ Request (application/json)
    + Attributes
        + email: `test@test.com` (required, string)
        + password: `passwordA6` (required, string) - min: 6, regex: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{6,}$
        + paymentPassword: `passwordA6` (required, string) - min: 6, regex: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{6,}$
        + name: `John Smith` (required, string) - min: 3
        + agreeTos: `true` (required, boolean) - only `true` allowed

    + Headers

            Accept: application/json

    + Body

            {
                "email": "ortga@gmail.com",
                "name": "John Smith",
                "password": "test12A6!@#$%^&*()_-=+|/",
                "paymentPassword": "payment12A6!@#$%^&*()_-=+|/",
                "agreeTos": true,
                "source": {
                "utm": "utm",
                "gtm": "gtm"
                }
            }

+ Response 200 (application/json)

        {
            "verification": {
                "id": "3ed09e0a-72e1-417b-a05c-f0f08a5e1ffa",
                "method": "email"
            },
            "email": "ortga@gmail.com",
            "name": "John Smith",
            "agreeTos": true,
            "isVerified": false,
            "defaultVerificationMethod": "email",
            "source": {
              "utm": "utm",
              "gtm": "gtm"
            }
        }

+ Response 400 (application/json)

        {
            "statusCode": 400,
            "error": "User already exists"
        }

## Activate a user [/user/activate]

This endpoint response with JWT token so user can be immediately redirected to dashboard.
JWT token received by `/activate` DOES NOT require verification.

### Activate a user [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "11d65c5b-000b-4bd8-a3ef-47b09c604fc9",
                    "code": "934415"
                }
            }

+ Response 200 (application/json)

        {
            "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
        }

## Initiate login [/user/login/initiate]

The accessToken got from this endpoint response MUST BE ALWAYS verified via `/user/login/verify`.
Authentication attempts with not verified token will result in 401 response.

### Initiate login [POST]

+ Request (application/json)
    + Attributes
        + email: `test@test.com` (required, string)
        + password: `passwordA6` (required, string)

    + Headers

            Accept: application/json

    + Body

            {
                "email": "test@test.com",
                "password": "test12A6!@#$%^&*()_-=+|/"
            }

+ Response 200 (application/json)

        {
            "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNhYTQzMzA0LTNhMTEtNDNkNy05NjNhLTRmNDA0OTY2MDVmMyIsImxvZ2luIjoidGVzdEB0ZXN0LmNvbSIsImRldmljZUlkIjoiZGV2aWNlIiwianRpIjoiM2FhNDMzMDQtM2ExMS00M2Q3LTk2M2EtNGY0MDQ5NjYwNWYzZGV2aWNlMTUwNzcxOTg1MzcwNiIsImlhdCI6MTUwNzcxOTg1MzcwNiwic3ViIjoiNWJiMzg5NzEtMWYyMi00Zjk5LWE5MDQtNjJmYjQ0NDMwYWI0IiwiYXVkIjoiamluY29yLmNvbSIsImV4cCI6MTUwNzcyMDQ1ODUwNn0.vaZtMpPlPZDSLCVpMMC2dpCvbSram9mXNBPAaxSupKc",
            "isVerified": false,
            "verification": {
                "verificationId": "7fa96769-7bcc-4705-b544-02a83707cfc8",
                "method": "email"
            }
        }

## Verify login [/user/login/verify]

### Verify login [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "7fa96769-7bcc-4705-b544-02a83707cfc8",
                    "code": "544188"
                }
            }

+ Response 200 (application/json)

        {
            "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNhYTQzMzA0LTNhMTEtNDNkNy05NjNhLTRmNDA0OTY2MDVmMyIsImxvZ2luIjoidGVzdEB0ZXN0LmNvbSIsImRldmljZUlkIjoiZGV2aWNlIiwianRpIjoiM2FhNDMzMDQtM2ExMS00M2Q3LTk2M2EtNGY0MDQ5NjYwNWYzZGV2aWNlMTUwNzcxOTg1MzcwNiIsImlhdCI6MTUwNzcxOTg1MzcwNiwic3ViIjoiNWJiMzg5NzEtMWYyMi00Zjk5LWE5MDQtNjJmYjQ0NDMwYWI0IiwiYXVkIjoiamluY29yLmNvbSIsImV4cCI6MTUwNzcyMDQ1ODUwNn0.vaZtMpPlPZDSLCVpMMC2dpCvbSram9mXNBPAaxSupKc",
            "isVerified": true
        }


## Initiate payment password change [/user/me/changePaymentPassword/initiate]

### Initiate payment password change [POST]

+ Request (application/json)
    + Attributes
        + oldPaymentPassword: `passwordA1` (required, string)
        + newPaymentPassword: `passwordA6` (required, string) - regex: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z0\d!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]{8,}$/

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "oldPaymentPassword": "test12A6!@#$%^&*()_-=+|/",
                "newPaymentPassword": "passwordA1"
            }

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "8f9ba03c-e903-459c-adb9-7594865a03a4",
                "method": "email"
            }
        }

## Verify payment password change [/user/me/changePaymentPassword/verify]

### Verify payment password change [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }

+ Response 200 (application/json)

        {
            "isChanged": true
        }

## Initiate password change [/user/me/changePassword/initiate]

### Initiate password change [POST]

+ Request (application/json)
    + Attributes
        + oldPassword: `passwordA1` (required, string)
        + newPassword: `passwordA6` (required, string) - regex: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z0\d!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]{8,}$/

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "oldPassword": "test12A6!@#$%^&*()_-=+|/",
                "newPassword": "passwordA1"
            }

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "8f9ba03c-e903-459c-adb9-7594865a03a4",
                "method": "email"
            }
        }

## Verify password change [/user/me/changePassword/verify]

### Verify password change [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }

+ Response 200 (application/json)

        {
            "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
        }

## Initiate password reset [/user/resetPassword/initiate]

### Initiate password reset [POST]

+ Request (application/json)
    + Attributes
        + email: `test@test.com` (string, required)

    + Headers

            Accept: application/json

    + Body

            {
                "email": "test@test.com"
            }

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "8f9ba03c-e903-459c-adb9-7594865a03a4",
                "method": "email"
            }
        }

## Verify password reset [/user/resetPassword/verify]

### Verify password reset [POST]

+ Request (application/json)
    + Attributes
        + email: `test@test.com` (required, string)
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Accept: application/json

    + Body

            {
                "email": "test@test.com",
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }

+ Response 200 (application/json)

        {
            "email": "test@test.com",
            "resetId": "JDJhJDEwJHpoenBLRkdPLi5rWVBhbTdqNmhrWWVOL0hQZm1GeUVYVGpMYkNUdWd5cW91WTNMaWc4eVBL"
        }

## Enter new password to reset [/user/resetPassword/enter]

### Enter new password to reset [POST]

+ Request (application/json)
    + Attributes
        + email (required, string)
        + password (required, string) - regex: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z0\d!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]{8,}$/
        + resetId (required, string) - unique code from the reset password verify step

    + Headers

            Accept: application/json

    + Body

            {
                "email": "test@test.com",
                "password": "test12A6!@#",
                "resetId": "JDJhJDEwJHpoenBLRkdPLi5rWVBhbTdqNmhrWWVOL0hQZm1GeUVYVGpMYkNUdWd5cW91WTNMaWc4eVBL"
            }

+ Response 200 (application/json)

        {
            "isReset": true
        }

+ Response 404 (application/json)

        {
            "statusCode": 404,
            "error": "User is not found"
        }

## Set notifications state [/user/preferences/notifications]

### Set notifications state [POST]

+ Request (application/json)
    + Attributes
        + notifications (required, object) - Allowed keys: user_signin, user_change_password, user_reset_password.

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "notifications": {
                    "user_signin": false,
                    "user_change_password": false,
                    "user_reset_password": true
                }
            }


+ Response 200 (application/json)

        {
            "notifications": {
                "user_signin": false,
                "user_change_password": false,
                "user_reset_password": true
            }
        }

## Initiate set verifications state [/user/preferences/verifications/initiate]

When verification is disabled the method in { verification : { verificationId: '...', method: 'inline' } will be `inline` only.
For inline method you should pass any code (random) for verify action.

### Initiate set verifications state [POST]

+ Request (application/json)
    + Attributes
        + verifications (required, object) - Allowed keys: user_signin, user_change_password, transaction_send.

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verifications": {
                    "user_signin": false,
                    "user_change_password": false,
                    "transaction_send": true
                }
            }

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "8f9ba03c-e903-459c-adb9-7594865a03a4",
                "method": "email"
            }
        }

## Verify set verifications state [/user/preferences/disableVerifications/verify]

### Verify set verifications state [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }

+ Response 200 (application/json)

        {
            "verifications": {
                "user_signin": false,
                "user_change_password": false,
                "transaction_send": true
            }
        }

## Initiate enable 2FA [/user/enable2fa/initiate]

### Initiate enable 2fa [GET]

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "61fa7fab-6abd-469c-9196-85680bab577a",
                "method": "google_auth",
                "totpUri": "otpauth://totp/Jincor:ortgma@gmail.com?secret=PWQGHWHUIXN6RDINTO4XUSFURXMKWWJO&issuer=Jincor&algorithm=SHA1&digits=6&period=30",
                "qrPngDataUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABHQAAAR0CAAAAAA1Zx5qAAAb20lEQVR42u3VwWHDIBREQffftFNE0O4izzuTWAL+6POVpGAfWyAJOpKgI0nQkQQdSYKOJOhIgo4kQUcSdCQJOpKgI0nQkQQdSdCRJOhIgo4kQUcSdCQJOpKgIwk6kgQdSdCRJOhIgo4k6EgSdCRBR5KgIwk6kgQdSdCRBB1Jgo4k6EgSdCRBR5KgIwk6kqAjSdCRBB1Jgo4k6EgSdCRBRxJ0JAk6kqAjSdCRBB1J0JEk6EiCjiRBRxJ0JAk6kqAjCTqSBB1J0JEk6EiCjiRBRxJ0JEFHkqAjCTqSBB1J0JEEHUmCjiToSBJ0JEFHkqAjCTqSoCNJ16HzGer087X+X+KMWmeZeObTd/cte594X+hABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtBpo/MNlLhsrQt941C3zmNpX9Y/PrWPHnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHeiU0Vk/pNPvsf4sS5f8RnRa53EjdtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKDzq+hMbX4JpyWwEpgsfQR+7eMNHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtB5briWDn3p3RLPsoTEr80RdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6NyMzo2HdHoYEnvaeo+l/VuC7S1zBB3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzq3oNPqNE7WWddctzRH0IGOddCBDnSssw460HF5rYMOdKBjnXXQgY511kEHOtCxDjrQgY511kEHOi6vddCBDnSssw460LHOOuhABzrWWQcd6FhnHXSgAx3roAMd6FhnHXSg4/JaBx3oQMc666ADHeusgw50oGOdddCBjnXWQWcRnfWWYDv9t6f34PRvtN73xjN69QxCBzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdAQd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBjqADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQ0UPoLF3e08PVgigxNK1a9yCB8Zv3GTrQMQzQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQsc/QgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6NjnRXRaICxdhNNDc+MQtoY18Szr75sAFTrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnR+AR1Dff5yJAZpaRhaH5olYL5DQQc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgc5T6CQ2qzWE64O+NAytD0jrA7cO9NSHBjrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnQuQad1UROXYx2JxKAvDeH6/1v6SEEHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IHOr6JT26zSYC6hmMB9aV/WP7YtsKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EBnEZ3ERi8NZuvQW8OfuLytIbzxjJYwgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgA502Oq1DSjzzr13e9Q/N0t1d/zhO7TN0oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oPIROYuBOb/T6AbfgOL2nSyi27ksL46m9hw50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgA50yOkubkDjMFkQt2N48cIkzf/XHDDrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnQeQidxmK3fbV3e1iC9GfzWb6zfZ+hABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtB5GzpLm78EUeLQ14er9R6tu9v60Ex9VKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EDnIXTWB7iF3RKerTNa+lgs3dP1jyN0oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3o3IJO4kVaB5x43xbGS3gu/e6NUM7PL3SgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehcgs4n0DdQC+PTg97a58RgLoG6fp+hAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehA5xZ0EhcmMfyJd1v6jTfv89KHIfH/pvYAOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdB5Cp3VIiU29cTDfss+nkW39bWufWx8f6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60FlEJ3F5l/7f0u8mLtun1DqU6/scmX3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQuRid1kYvHdzSoCf2OYHEW85ofg+gAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehA5yF0EoOZ2KzEM/9nr1qXrYVJYv8S53H6+a78OEIHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IHOQ+gsHcjSpWxB/ua9Xx/+pZbeAzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSS6LRwOn0gpw/uUypxHje+xzrab0EROtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdJ5CZ2nzlw4pAeoSxuuwJfY+cR6JewAd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc6t6CzPoStwVwCpoX70rMsDWYL99oHGDrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSC6CwNegLF1gEv/b/WgKwPa2Soh4CBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADnSQ6pw8kcWHWoUwMf2Ld0nu0PiCtdS0AoQMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQCeJztJhvgXAxJ62QKhd/MCzrIMPHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOm9DZwmOpQu4dClvHJrTz/xmyJfuEHSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHei00Wnh9A00dZiH97T1G0v3r/WBW/+AQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgc7b0HEBtwb9c7jW767ftV/7eEMHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IHOU+gkgGld/MSzJJ4ZgJnfXUIigQl0oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3o3ILO6ctxepBa77uEXWtfltBZwv3GWYAOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAOdJDpLFyHxLOu/23qPdcTW4V3/SEEHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IHOIjrrJQ5z/Xf/s+4/+7x+Rm/Z5wQc0IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oLOIzmeo1vNBNjOES/dqCTHoQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgU72hROX98ZBXxquxN24ce/XEYMOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAOdt6GzfjlaOCUwWaq1V62/be1p6yMAHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtB5cAMP/+76+7YwToCVOI8E0K27Cx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQyQ7/+gVMXOjE87XQWfpYnL5XtY8UdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6JTRWfrd1qU8jWwC7RaA63AsPd86RNCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKCTRKdVYlgTw9WCY32fE/d0Cae3nAd0oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oQAc60IEOdKADHehABzrQgQ50oAMd6EAHOtCBDnSgAx3oPIWOJEFHEnQkQUeSoCMJOpIEHUnQkSToSIKOJOhIEnQkQUeSoCMJOpIEHUnQkQQdSYKOJOhIEnQkQUcSdCQJOpKgI0nQkQQdSYKOJOhIgo4kQUcSdCQJOpKgI0nQkQQdSdCRJOhIgo4kQUcSdCQJOpKgIwk6kgQdSdCRJOhIgo4k6EgSdCRBR5KgIwk6kgQdSdCRBB1Jgo4k6EgSdCRBR5KgIwk6kqAjSdCRBB1Jgo4k6EiCjiRBRxJ0JAk6kqAjSdCRBB1J0JEk6EiCjiRBRxJ0JAk6kqr9AbAjw8ghNgbcAAAAAElFTkSuQmCC"
            }
        }

## Verify enable 2fa [/user/enable2fa/verify]

### Verify enable 2fa [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }

+ Response 200 (application/json)

        {
            "enabled": false
        }

## Initiate disable 2FA [/user/disable2fa/initiate]

### Initiate disable 2fa [GET]

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "0e47a5fd-d7f7-43af-b080-3918e49bf211",
                "method": "google_auth"
            }
        }

## Verify disable 2fa [/user/disable2fa/verify]

### Verify disable 2fa [POST]

+ Request (application/json)
    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }



+ Response 200 (application/json)

        {
            "enabled": false
        }

## Wallets [/user/me/wallets]

### Create new wallet [POST]

+ Request (application/json)
    + Attributes
        + type: `ETH` (required, string) - Only ETH allowed.
        + paymentPassword: `passwordA6` (required, string) - min: 6, regex: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{6,}$
        + name (required, string)
        + color (required, number)

    + Headers

            Accept: application/json

    + Body

            {
                "type": "ETH",
                "paymentPassword": "payment12A6!@#$%^&*()_-=+|/",
                "name": "some name",
                "color": #F0F1F2
            }

+ Response 200 (application/json)

            {
                "ticker": "ETH",
                "address": "0xdb369b56BA7b07cF287f611Fbf0DAA4A8a4C2751",
                "tokens": [],
                "name": "some name",
                "color": "#F0F1F2"
            }

### Update wallet [PUT]

+ Request (application/json)
    + Attributes
        + address (required, string)
        + name (string) - Required if color is not presented
        + color (number) - Required if name is not presented

    + Headers

            Accept: application/json

    + Body

            {
                "address": "0xdb369b56BA7b07cF287f611Fbf0DAA4A8a4C2751",
                "name": "some name",
                "color": #F0F1F2
            }

+ Response 200 (application/json)

            {
                "ticker": "ETH",
                "address": "0xdb369b56BA7b07cF287f611Fbf0DAA4A8a4C2751",
                "tokens": [],
                "name": "some name",
                "color": "#F0F1F2"
            }

## Register ERC20 token [/user/me/erc20token/register]

### Register ERC20 token [POST]

+ Request (application/json)
    + Attributes
        + walletAddress (required, string)
        + contractAddress (required, string)
        + name (optional, string)
        + symbol (required, string)
        + decimals (required, number)

    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "walletAddress": "0x7EB6Bea6eCf5aF3eA9c7e9dcb4D71966CFA4c9Eb",
                "contractAddress": "0xc20f363f721fe8b35cc2aafd18df7156c775d642",
                "name": "My Token",
                "symbol": "SAV",
                "decimals": 18
            }



+ Response 200 (application/json)

        {
            "walletAddress": "0x7EB6Bea6eCf5aF3eA9c7e9dcb4D71966CFA4c9Eb",
            "contractAddress": "0xc20f363f721fe8b35cc2aafd18df7156c775d642",
            "name": "My Token",
            "symbol": "SAV",
            "decimals": 18
        }

## Get user info [/user/me]

### Get user info [GET]

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        {
            "wallets": [
                {
                    "ticker": "ETH",
                    "address": "0xdb369b56BA7b07cF287f611Fbf0DAA4A8a4C2751"
                    "tokens": [
                        {
                            "contractAddress": "0xc31382ef54b77be67605980197b76a40417b5a74",
                            "name": "My Token",
                            "symbol": "SAV",
                            "decimals": 18
                        }
                    ]
                }
            ],
            "preferences": {
                "notifications": {
                    "user_signin": false,
                    "user_change_password": false,
                    "user_reset_password": true
                },
                "verifications": {
                    "user_signin": false,
                    "user_change_password": false,
                    "transaction_send": true
                }
            },
            "email": "existing@test.com",
            "name": "John Smith",
            "defaultVerificationMethod": "email"
        }

# Group Dashboard

## Get dashboard info [/dashboard{?walletAddress}]

### Get dashboard info [GET]

+ Parameters

    + walletAddress (required, string) - Wallet address.

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        {
            "ethBalance": "1.0001",
            "erc20TokensBalance": [
                {
                    "name": "Super Active V",
                    "symbol": "SAV",
                    "decimals": 18,
                    "contractAddress": "0x1234123412341234123412341234",
                    "balance": "500.00012345678912345"
                }
            ]
        }

## Get minimal expected transaction fee [/dashboard/transactionFee{?gas}]

### Get minimal expected transaction fee [GET]

+ Parameters

    + gas (required, string) - Gas value

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        {
            "gasPrice": "82",
            "gas": "10000",
            "expectedTxFee": "0.00082"
        }

## Get ERC20 token information [/dashboard/erc20TokenInfo{?contractAddress}]

### Get ERC20 token information [GET]

+ Parameters

    + contractAddress (required, string) - Contract address of ERC20 token (example, 0xc20f363f721fe8b35cc2aafd18df7156c775d642)

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        {
            "id": "5a71dc0a73d1e40da04be94a",
            "contractAddress": "0xc20f363f721fe8b35cc2aafd18df7156c775d642",
            "name": "Super",
            "symbol": "SAV",
            "decimals": 18,
            "createdAt": 1517411338
        }

+ Response 404 (application/json)

        {
            "message": "Information is unavailable",
            "status": 404
        }

## Get transaction history [/dashboard/transactions{?walletAddress}{?page}{?limit}]

### Get transaction history [GET]

+ Parameters

    + walletAddress (required, string) - Wallet address
    + page (optional, number)
    + limit (optional, number) - default value 50 if limit is not exist

+ Request

    + Headers

            Authorization: Bearer token
            Accept: application/json

+ Response 200 (application/json)

        [
            page: 1,
            count: 5,
            limit: 50,
            data: [
                {
                    "id": "5a003866ee3a9d0ad93aeba3",
                    "transactionHash": "0xe423dd7d40b039e4e30ad7b5520f5905c6ec8c11122c94e3858c70e7983b5d7e",
                    "timestamp": 1509963894,
                    "blockNumber": 2016136,
                    "contractAddress": "0xc20f363f721fe8b35cc2aafd18df7156c775d642",
                    "from": "0xBd0cb067A75C23EFB290B4e223059Af8E4AF4fd8",
                    "to": "0x446cd17EE68bD5A567d43b696543615a94b01760",
                    "amount": "1000",
                    "status": "confirmed",
                    "type": "erc20_transfer",
                    "direction": "out"
                },
                {
                    "id": "5a004158b8442c0e1400fc4f",
                    "transactionHash": "0xcdf4a9dc086bcb3308475ced42b772879fd052822693aee509f81493412d460f",
                    "timestamp": 1509966175,
                    "blockNumber": 2016339,
                    "token": {
                        "contractAddress": "0xc20f363f721fe8b35cc2aafd18df7156c775d642",
                        "symbol": "SAV",
                        "name": "Super Activate V",
                        "decimals": 18
                    },
                    "from": "0x446cd17EE68bD5A567d43b696543615a94b01760",
                    "to": "0xBd0cb067A75C23EFB290B4e223059Af8E4AF4fd8",
                    "amount": "1000",
                    "status": "confirmed",
                    "type": "erc20_transfer",
                    "direction": "out"
                },
                {
                    "id": "5a004dee3663160140d19291",
                    "transactionHash": "0xe5d5ed39bf9eb64d3e56bf4a9d89b7f2bb026fc02c0d149027757936a1e7b6c7",
                    "timestamp": 1509969394,
                    "blockNumber": 2016578,
                    "from": "0xBd0cb067A75C23EFB290B4e223059Af8E4AF4fd8",
                    "to": "0x446cd17EE68bD5A567d43b696543615a94b01760",
                    "amount": "2",
                    "status": "confirmed",
                    "type": "eth_transfer",
                    "direction": "out"
                },
                {
                    "id": "5a004e003663160140d19292",
                    "transactionHash": "0x057c0846b7b7fa54c10544c595ec2e476c830220f0ea1fbb52215a3a44deade1",
                    "timestamp": 1509969394,
                    "blockNumber": 2016578,
                    "from": "0xBd0cb067A75C23EFB290B4e223059Af8E4AF4fd8",
                    "to": "0x446cd17EE68bD5A567d43b696543615a94b01760",
                    "amount": "2",
                    "status": "confirmed",
                    "type": "eth_transfer",
                    "direction": "out"
                },
                {
                    "id": "5a00669ab21e84067aac8bf6",
                    "transactionHash": "0xb87ef88fe75724ed067413de7c48f4c745cfafa709f42884308663cb53a8e2a0",
                    "timestamp": 1509975754,
                    "from": "0x54c0B824d575c60F3B80ba1ea3A0cCb5EE3F56eA",
                    "to": "0xBd0cb067A75C23EFB290B4e223059Af8E4AF4fd8",
                    "amount": "5",
                    "status": "pending",
                    "type": "eth_transfer",
                    "direction": "in"
                }
            ]
        ]

## Initiate transaction [/dashboard/transaction/initiate]

### Initiate transaction [POST]

+ Attributes
    + amount: `1` (required, number)
    + paymentPassword: `payment12A6` (required, string)
    + type: `eth_transfer` (required, string) - One of `eth_transfer`, `erc20_transfer`.
    + from (required, string) - Source wallet address
    + to (required, string) - Destination wallet address
    + gas (optional, string) - Customization of gas limit
    + gasPrice (optional, string) - Customization of gas price

+ Request
    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "amount": 1000,
                "paymentPassword": "payment12A6"
                "type": "erc20_transfer",
                "from": "0x446cd17EE68bD5A567d43b696543615a94b01760",
                "contractAddress": "0xc20f363f721fe8b35cc2aafd18df7156c775d642",
                "to": "0x81c51b9c45D38f3AAB102a430D8aDFFF0523dCFe"
            }

+ Response 200 (application/json)

        {
            "verification": {
                "verificationId": "a4d642d6-8c96-4435-94b8-9a2bbd501552",
                "method": "email"
            }
        }

## Verify transaction [/dashboard/transaction/verify]

### Verify transaction [POST]

+ Request (application/json)

    + Attributes
        + verification (required, object)
            + verificationId: `UUID` (required, string)
            + code: `000000` (required, string)


    + Headers

            Authorization: Bearer token
            Accept: application/json

    + Body

            {
                "verification": {
                    "verificationId": "b41498d8-a9db-4bb5-b338-0e8f47582066",
                    "code": "813365"
                }
            }



+ Response 200 (application/json)

        {
            "transactionHash": "0xf33afe0b5b56dfb6584d308d7b5e4c0412041045f3f728708eb90ac6f48e0956",
            "status": "pending",
            "type": "eth_transfer"
        }