taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

post-kyc-start-ID.rst (1197B)

      1 .. http:post:: /kyc-start/$ID
      2 
      3   The ``/kyc-start/$ID`` POST endpoint allows the SPA to set up a new external
      4   KYC process. It will return the URL that the client must GET to begin the
      5   KYC process. The SPA should probably open this URL in a new window or tab.
      6   The ``$ID`` will be provided as part of the ``/kyc-info`` body.  In
      7   practice, ``$ID`` will encode the ``$ACCESS_TOKEN``, legitimization measure
      8   serial ID (to disambiguate) and the index of the selected measure (but these
      9   details should be irrelevant for the client).
     10 
     11   **Request:**
     12 
     13   Use empty JSON body for now.
     14 
     15   **Response:**
     16 
     17   :http:statuscode:`200 Ok`:
     18     The KYC process was successfully initiated. The URL is in a
     19     `KycProcessStartInformation` object.
     20   :http:statuscode:`404 Not Found`:
     21     The ``$ID`` is unknown to the exchange.
     22 
     23   **Details:**
     24 
     25   .. ts:def:: KycProcessStartInformation
     26 
     27     interface KycProcessStartInformation {
     28 
     29       // URL to open.
     30       redirect_url: string;
     31     }
     32 
     33   .. note::
     34 
     35     As this endpoint is involved in every KYC check at the beginning, this
     36     is also the place where we could integrate the payment process for the KYC fee
     37     in the future (since protocol **vATTEST**).