chore: Merge pull request #4 from avengedpeak/main

Update specification for LSP usecase

Author: dheerajkhardwal

specification/request-specification.md

@@ -17,7 +17,11 @@ WebView Endpoint
 {% api-method-request %}
 {% api-method-path-parameters %}
 {% api-method-parameter type="string" name="fi" required=true %}
-Unique FIU identifier. This will be encrypted using Base64/XOR along with **reqdate** field.
+Unique requestor identifier. This will be encrypted using Base64/XOR along with **reqdate** field.
+{% endapi-method-parameter %}
+
+{% api-method-parameter type="ENUM" name="requestorType" required=false %}
+Type of the requestor. This field will hold the values - FIU & LSP. The ENUM field would be expanded to accommodate new participants for any future requirements.  This will be encrypted using Base64/XOR along with **reqdate** field.
 {% endapi-method-parameter %}
 
 {% api-method-parameter name="reqdate" required=true type="string" %}
@@ -50,11 +54,11 @@ Below are the parameters that will be encrypted using AES256 encryption algorith
 
 | **Parameter name** | **Parameter type** | **Parameter description** |
 | :--- | :--- | :--- |
-| txnid | String | UUID txnid. Uniquely identifies a particular redirection event. This same value will be returned by AA to FIU in the ecres txnid field. |
-| sessionid | String | Value that represents a ‘state’ \(or session\) on the FIU end. This value is opaque to AA and will be returned as is to the FIU by AA in ecres sessionid field. |
+| txnid | String | UUID txnid. Uniquely identifies a particular redirection event. This same value will be returned by AA to requestor in the ecres txnid field. |
+| sessionid | String | Value that represents a ‘state’ \(or session\) on the requestor end. This value is opaque to AA and will be returned as is to the requestor by AA in ecres sessionid field. |
 | userid | String | The AA user id \( Refer to A\] below \) |
-| redirect | String | FIU Url that AA needs to call back after the user has provided consent in the AA domain. The value of this parameter should be URL encoded if the value contains url parameters. This is required in order to remove ambiguity between the parameters of ecreq \(separated by ‘&’ character\) with the parameters in the redirect url. |
-| srcref | String | Consent handle id, as returned by AA server to the /Consent request api invoked by FIU on the AA prior to this redirection call. |
+| redirect | String | Requestor Url that AA needs to call back after the user has provided consent in the AA domain. The value of this parameter should be URL encoded if the value contains url parameters. This is required in order to remove ambiguity between the parameters of ecreq \(separated by ‘&’ character\) with the parameters in the redirect url. |
+| srcref | Array | Array of consent handle id(s), as returned by AA server to the /Consent request api invoked by the FIU(s) on the AA prior to this redirection call.|
 
 ## userid
 

specification/response-specification.md

@@ -55,9 +55,9 @@ Below are the parameters that will be encrypted using AES256 encryption algorith
 | txnid | String | UUID txnid \( To be sent back from the request \) |
 | sessionid | String | Value of sessionid received in the ‘ecreq’ field in the request. |
 | userid | String | The AA user id |
-| status | String | The status ‘S’ for success and ‘F’ for failure |
-| errorcode | String | Refer the errorcodes table below |
-| srcref | String | The consent handle id received in the ecreq ‘srcref’ field |
+| status | String | The status ‘S’ for success ( atleast one consent is approved ) and ‘F’ for failure ( all consents declined ) |
+| errorcode | String | The response code : 0 if status is ‘S’ and others for failure (Refer to Error Codes table below) |
+| srcref | Array | Array of accepted consent handle identifiers only in case of LSP |
 
 ## Error codes