API
===================

In this section we define the API of VerX, which can be used to integrate VerX with existing platforms and protocols.

Authentication
-------------------------
To request an `access_token` please send us an email to contact@chainsecurity.com

Submit a verification job
-------------------------

To submit a job to VerX you need to make 

Submit request

.. code-block:: javascript

    {
       "code": <contract code>
       "deployer": <deployment script>
       "spec": <property>
    }

Responses
---------

1. Verified

Verified response

.. code-block:: javascript

    {
       "status": "verified"
    }

2. May not hold

Failed to verify response

.. code-block:: javascript

    {
       "status": "may_not_hold"
       "violation_trace": <string>
    }

3. Timeout

Timeout

.. code-block:: javascript

    {
       "status": "timeout"
    }

4. Input error messages

Contract parse error

.. code-block:: javascript

    {
       "status": "solidity_parse_error"
       "error": <string>
    }

Specification parse error

.. code-block:: javascript

    {
       "status": "spec_parse_error"
       "error": <string>
    }

Deployment scripts parse error

.. code-block:: javascript

    {
       "status": "deploy_error"
       "error": <string>
    }

5. Runtime error

Response

.. code-block:: javascript

    {
       "status": "runtime_error"
       "error": <string>
    }