KYC-Match: Error responses alignment with Commonalities

code/API_definitions/kyc-match.yaml

@@ -45,6 +45,20 @@ info:
 
     It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
 
+    # Identifying a phone number from the access token
+    This specification defines the `phoneNumber` field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the phone number can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the information associated with the access token used to invoke the API.
+    ## Handling of phone number information:
+    ### Optional `phoneNumber` field for 3-legged tokens:
+    - When using a 3-legged access token, the phone number associated with the access token must be considered as the phone number for the API request. This means that the `phoneNumber` field is not required in the request, and if included it must identify the same phone number, therefore **it is recommended NOT to include it in these scenarios** to simplify the API usage and avoid additional validations.
+    ### Validation mechanism:
+    - The server will extract the phone number identification from the access token, if available.
+    - If the API request additionally includes a `phoneNumber` field when using a 3-legged access token, the API will validate that the phone number provided matches the one associated with the access token.
+    - If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the phone number information in the request does not match the token.
+    ### Error handling for unidentifiable phone number:
+    - If the `phoneNumber` field is not included in the request and the phone number information cannot be derived from the 3-legged access token, the server will return a 422 `UNIDENTIFIABLE_PHONE_NUMBER` error.
+    ### Restrictions for tokens without an associated authenticated phone number:
+    - For scenarios which do not have a phone number associated to the token during the authentication flow, e.g. 2-legged access tokens, the `phoneNumber` field MUST be provided in the API request. This ensures that the phone number is explicit and valid for each API call made with these tokens.
+
 
   license:
     name: Apache 2.0
@@ -161,6 +175,9 @@ paths:
         '404':
           $ref: '#/components/responses/Generic404'
 
+        '422':
+          $ref: '#/components/responses/Generic422'
+
         '500':
           $ref: '#/components/responses/Generic500'
 
@@ -520,9 +537,31 @@ components:
             NotFound:
               value:
                 status: 404
-
                 code: NOT_FOUND
                 message: not_found_contractor/not_found
+    Generic422:
+      description: Unprocessable Content
+      headers:
+        x-correlator:
+          $ref: "#/components/headers/x-correlator"
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorInfo"
+          examples:
+            GENERIC_422_NOT_SUPPORTED:
+              description: Not Supported
+              value:
+                status: 422
+                code: NOT_SUPPORTED
+                message: Service not supported for this phoneNumber
+            UNIDENTIFIABLE_PHONE_NUMBER:
+              description: The phone number is not included in the request and the phone number information cannot be derived from the 3-legged access token
+              value:
+                status: 422
+                code: UNIDENTIFIABLE_PHONE_NUMBER
+                message: The phone number cannot be identified           
+
 
     Generic500:
       description: Server error.  Problem with MNO's server side.  Some processing error within MNO's servers.
@@ -539,7 +578,7 @@ components:
               value:
                 status: 500
                 code: INTERNAL
-                message: Server error
+                message: Unknown server error. Typically a server bug.
 
     Generic503:
       description: Service unavailable. Typically the server is down.  Problem with MNO's server side.  Any unexpected error within MNO's servers.