diff options
Diffstat (limited to 'core/api-challenger.rst')
-rw-r--r-- | core/api-challenger.rst | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/core/api-challenger.rst b/core/api-challenger.rst index 265ad5a6..914d8d01 100644 --- a/core/api-challenger.rst +++ b/core/api-challenger.rst @@ -49,9 +49,9 @@ particular address. However, asking a user to prove access to a particular address can be expensive as it may involve sending an SMS or even postal mail depending on the type of address. Thus, challenger does not allow a user agent to begin an address validation process without prior approval by a -registered client. Thus, the process begins with a ``/setup`` request where a +registered client. Thus, the process begins with a ``/setup/$CLIENT_ID`` request where a client requests challenger to begin an address validation request. The -``/setup`` response contains a ``nonce`` which is then used to construct the +``/setup/$CLIENT_ID`` response contains a ``nonce`` which is then used to construct the URL of the endpoint to which the client must redirect the user-agent to begin the address validation and authorization process. @@ -88,6 +88,7 @@ Using the ``/info`` endpoint the client can then finally obtain the (now) verified address of the user. .. contents:: Table of Contents + :local: .. include:: tos.rst @@ -98,6 +99,7 @@ Receiving Configuration .. http:get:: /config Obtain the key configuration settings of the storage service. + This specification corresponds to ``current`` protocol being version **0**. **Response:** @@ -114,6 +116,10 @@ Receiving Configuration // The format is "current:revision:age". version: string; + // URN of the implementation (needed to interpret 'revision' in version). + // @since v0, may become mandatory in the future. + implementation?: string; + } .. _challenger-setup: @@ -327,8 +333,15 @@ Info .. ts:def:: ChallengerInfoResponse interface ChallengerInfoResponse { + + // Unique ID of the record within Challenger + // (identifies the rowid of the token). + id: Integer; + // Address that was validated. - address: string; + // Key-value pairs, details depend on the + // address_type. + address: Object; // Type of the address. address_type: string; |