diff --git a/api-references/data/account-aggregator.json b/api-references/data/account-aggregator.json index 434710f5..a9cdb45d 100644 --- a/api-references/data/account-aggregator.json +++ b/api-references/data/account-aggregator.json @@ -7,25 +7,22 @@ "email": "aa@setu.co" }, "title": "AA Gateway", - "version": "v1" + "version": "v2" }, - "servers": [], - "tags": [ - { - "name": "AA participants APIs", - "description": "APIs to fetch Account Aggregator ecosystem participants data i.e FIPs, FIUs or AAs" - }, + "servers": [ { - "name": "Consent APIs", - "description": "APIs for Consent management" + "url": "https://fiu-sandbox.setu.co/", + "description": "Sandbox" }, { - "name": "FI data fetch APIs", - "description": "APIs for FI data flow" - }, + "url": "https://fiu.setu.co", + "description": "Production" + } + ], + "tags": [ { - "name": "Notification APIs", - "description": "APIs to receive notifications from AA" + "name": "AA participants APIs", + "description": "APIs to fetch Account Aggregator ecosystem participants data i.e FIPs, FIUs or AAs" }, { "name": "Consent V2 APIs", @@ -58,34 +55,26 @@ ] } }, - "/consents": { + "/v2/consents": { "post": { "parameters": [ { "in": "header", - "name": "x-client-id", - "required": false, - "description": "Client ID of FIU", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-vault-config", - "required": false, - "description": "Path to fetch config from Vault", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } }, { "in": "header", - "name": "x-api-key", + "name": "x-product-instance-id", "required": true, - "description": "API key to call service", + "description": "Product instance ID of FIU", "schema": { - "type": "string" + "type": "string", + "minLength": 1 } } ], @@ -105,7 +94,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConsentResponse" + "$ref": "#/components/schemas/ConsentResponseV2" } } } @@ -116,7 +105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateConsentsRequest" + "$ref": "#/components/schemas/CreateConsentRequestV2" } } } @@ -124,38 +113,40 @@ "summary": "Create consent", "description": "This API is intended for AA Client to request generation of digitally signed consent artefacts. The customer has to use the AA application to select accounts and approve consent generation. Once the customer approves the consent request on the AA application, AA generates the digitally signed consent artefacts. Note - The AA Client never sees the account of the customer or directly participates in consent generation.\n\nNote: \u201cRequest Body Example Value\u201d and \u201cResponses Example Value\u201d given below is for illustrative purposes only.", "tags": [ - "Consent APIs" + "Consent V2 APIs" ] } }, - "/consents/{request_id}": { + "/v2/consents/{request_id}": { "get": { "parameters": [ { - "in": "header", - "name": "x-client-id", + "in": "query", + "name": "expanded", "required": false, - "description": "Client ID of FIU", + "description": "Get expanded response", "schema": { - "type": "string" + "type": "boolean", + "default": false } }, { "in": "header", - "name": "x-vault-config", - "required": false, - "description": "Path to fetch config from Vault", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } }, { "in": "header", - "name": "x-api-key", + "name": "x-product-instance-id", "required": true, - "description": "API key to call service", + "description": "Product instance ID of FIU", "schema": { - "type": "string" + "type": "string", + "minLength": 1 } } ], @@ -175,7 +166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConsentResponse" + "$ref": "#/components/schemas/ConsentResponseV2" } } } @@ -184,7 +175,7 @@ "summary": "Get a consent", "description": "This API gets consent information using request ID.", "tags": [ - "Consent APIs" + "Consent V2 APIs" ] }, "parameters": [ @@ -199,34 +190,26 @@ } ] }, - "/consents/{request_id}/revoke": { + "/v2/consents/{request_id}/revoke": { "post": { "parameters": [ { "in": "header", - "name": "x-client-id", - "required": false, - "description": "Client ID of FIU", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-vault-config", - "required": false, - "description": "Path to fetch config from Vault", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } }, { "in": "header", - "name": "x-api-key", + "name": "x-product-instance-id", "required": true, - "description": "API key to call service", + "description": "Product instance ID of FIU", "schema": { - "type": "string" + "type": "string", + "minLength": 1 } } ], @@ -255,7 +238,7 @@ "summary": "Revoke a consent", "description": "This API revokes a consent based on request ID.", "tags": [ - "Consent APIs" + "Consent V2 APIs" ] }, "parameters": [ @@ -270,17 +253,27 @@ } ] }, - "/consents/consents/collection": { + "/v2/consents/collection": { "post": { "parameters": [ { "in": "header", - "name": "x-client-id", - "required": false, - "description": "Client ID of FIU", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } + }, + { + "in": "header", + "name": "x-product-instance-id", + "required": true, + "description": "Product instance ID of FIU", + "schema": { + "type": "string", + "minLength": 1 + } } ], "responses": { @@ -316,23 +309,32 @@ } }, "summary": "Create multi consent", - "description": "This API creates multi consent", "tags": [ - "Consent APIs" + "Consent V2 APIs" ] } }, - "/consents/consents/collection/{id}": { + "/v2/consents/collection/{id}": { "get": { "parameters": [ { "in": "header", - "name": "x-client-id", - "required": false, - "description": "Client ID of FIU", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } + }, + { + "in": "header", + "name": "x-product-instance-id", + "required": true, + "description": "Product instance ID of FIU", + "schema": { + "type": "string", + "minLength": 1 + } } ], "responses": { @@ -351,9 +353,8 @@ } }, "summary": "Get multi consent", - "description": "This API gets multi consent", "tags": [ - "Consent APIs" + "Consent V2 APIs" ] }, "parameters": [ @@ -368,35 +369,83 @@ } ] }, - "/sessions": { - "post": { + "/v2/consents/{consent_id}/fetch/status": { + "get": { "parameters": [ { "in": "header", - "name": "x-client-id", - "required": false, - "description": "Client ID of FIU", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } }, { "in": "header", - "name": "x-vault-config", - "required": false, - "description": "Path to fetch config from Vault", + "name": "x-product-instance-id", + "required": true, + "description": "Product instance ID of FIU", "schema": { - "type": "string" + "type": "string", + "minLength": 1 + } + } + ], + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } } }, + "200": { + "description": "OK" + } + }, + "summary": "Get last fetch status", + "description": "This API gets the last data fetch status for a consent", + "tags": [ + "Consent V2 APIs" + ] + }, + "parameters": [ + { + "in": "path", + "name": "consent_id", + "required": true, + "schema": { + "type": "string", + "minLength": 1 + } + } + ] + }, + "/v2/sessions": { + "post": { + "parameters": [ { "in": "header", - "name": "x-api-key", + "name": "Authorization", "required": true, - "description": "API key to call service", + "description": "Authorization Bearer token", "schema": { "type": "string" } + }, + { + "in": "header", + "name": "x-product-instance-id", + "required": true, + "description": "Product instance ID of FIU", + "schema": { + "type": "string", + "minLength": 1 + } } ], "responses": { @@ -415,7 +464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FIDataFetchResponse" + "$ref": "#/components/schemas/FIDataFetchResponseV2" } } } @@ -426,7 +475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateFIDataFetchRequest" + "$ref": "#/components/schemas/CreateFIDataFetchRequestV2" } } } @@ -434,38 +483,30 @@ "summary": "Create FI data fetch", "description": "This API is used to initiate a data fetch for FI data.", "tags": [ - "FI data fetch APIs" + "FI data fetch V2 APIs" ] } }, - "/sessions/{request_id}": { + "/v2/sessions/{session_id}": { "get": { "parameters": [ { "in": "header", - "name": "x-client-id", - "required": false, - "description": "Client ID of FIU", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-vault-config", - "required": false, - "description": "Path to fetch config from Vault", + "name": "Authorization", + "required": true, + "description": "Authorization Bearer token", "schema": { "type": "string" } }, { "in": "header", - "name": "x-api-key", + "name": "x-product-instance-id", "required": true, - "description": "API key to call service", + "description": "Product instance ID of FIU", "schema": { - "type": "string" + "type": "string", + "minLength": 1 } } ], @@ -485,7 +526,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FIDataFetchResponse" + "$ref": "#/components/schemas/FIDataFetchResponseV2" } } } @@ -494,13 +535,13 @@ "summary": "Get FI data", "description": "This API gets consent information using request ID.", "tags": [ - "FI data fetch APIs" + "FI data fetch V2 APIs" ] }, "parameters": [ { "in": "path", - "name": "request_id", + "name": "session_id", "required": true, "schema": { "type": "string", @@ -508,2450 +549,994 @@ } } ] - }, - "/Consent/Notification": { - "post": { - "parameters": [ - { - "in": "header", - "name": "aa_api_key", - "required": true, - "description": "API key used to verify AA's identity", - "schema": { - "type": "string" + } + }, + "components": { + "schemas": { + "FIDataFetchResponseV2": { + "type": "object", + "properties": { + "fips": { + "type": "array", + "nullable": true, + "description": "Array of accounts for a particular fip", + "items": { + "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItem1" } }, - { - "in": "body", - "required": true, - "name": "body", - "schema": { - "$ref": "#/components/schemas/PassDownSerializedBody" - } + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "PENDING", + "COMPLETED", + "EXPIRED", + "FAILED", + "PARTIAL" + ], + "description": "Status for this data fetch session" }, - { - "in": "header", - "name": "x-jws-signature", - "required": true, - "description": "Detached JWS of request body", - "schema": { - "type": "string" - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BadRequestConsentFetch" - } - } - } + "consentId": { + "type": "string", + "format": "uuid", + "description": "Consent identifier for this data fetch request." }, - "503": { - "description": "Service Unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceUnavailable" - } + "dataRange": { + "description": "Time range for which the data is being requested", + "allOf": [ + { + "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InternalServerError" - } - } - } - }, - "412": { - "description": "Precondition Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreconditionFailed" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Conflict" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotFound" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnauthorizedAccess" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationResponse" - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentStatusNotification" - } - } - } - }, - "summary": "Consent notification endpoint", - "description": "This endpoint is used by AA to send Consent Status notifications.", - "tags": [ - "Notification APIs" - ] - } - }, - "/FI/Notification": { - "post": { - "parameters": [ - { - "in": "header", - "name": "aa_api_key", - "required": true, - "description": "API key used to verify AA's identity", - "schema": { - "type": "string" - } - }, - { - "in": "body", - "required": true, - "name": "body", - "schema": { - "$ref": "#/components/schemas/PassDownSerializedBody" - } - }, - { - "in": "header", - "name": "x-jws-signature", - "required": true, - "description": "Detached JWS of request body", - "schema": { - "type": "string" - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BadRequestConsentFetch" - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceUnavailable" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InternalServerError" - } - } - } - }, - "412": { - "description": "Precondition Failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreconditionFailed" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Conflict" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotFound" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnauthorizedAccess" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationResponse" - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIStatusNotification" - } - } - } - }, - "summary": "FI data notification endpoint", - "description": "This endpoint is used by AA to send FI data notifications.", - "tags": [ - "Notification APIs" - ] - } - }, - "/v2/consents": { - "post": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentResponseV2" - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateConsentRequestV2" - } - } - } - }, - "summary": "Create consent", - "description": "This API is intended for AA Client to request generation of digitally signed consent artefacts. The customer has to use the AA application to select accounts and approve consent generation. Once the customer approves the consent request on the AA application, AA generates the digitally signed consent artefacts. Note - The AA Client never sees the account of the customer or directly participates in consent generation.\n\nNote: \u201cRequest Body Example Value\u201d and \u201cResponses Example Value\u201d given below is for illustrative purposes only.", - "tags": [ - "Consent V2 APIs" - ] - } - }, - "/v2/consents/{request_id}": { - "get": { - "parameters": [ - { - "in": "query", - "name": "expanded", - "required": false, - "description": "Get expanded response", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentResponseV2" - } - } - } - } - }, - "summary": "Get a consent", - "description": "This API gets consent information using request ID.", - "tags": [ - "Consent V2 APIs" - ] - }, - "parameters": [ - { - "in": "path", - "name": "request_id", - "required": true, - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - }, - "/v2/consents/{request_id}/revoke": { - "post": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RevokeConsentResponse" - } - } - } - } - }, - "summary": "Revoke a consent", - "description": "This API revokes a consent based on request ID.", - "tags": [ - "Consent V2 APIs" - ] - }, - "parameters": [ - { - "in": "path", - "name": "request_id", - "required": true, - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - }, - "/v2/consents/collection": { - "post": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MultiConsentResponse" - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MultiConsentRequest" - } - } - } - }, - "summary": "Create multi consent", - "tags": [ - "Consent V2 APIs" - ] - } - }, - "/v2/consents/collection/{id}": { - "get": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "$ref": "#/components/responses/BAD_REQUEST" - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MultiConsentResponse" - } - } - } - } - }, - "summary": "Get multi consent", - "tags": [ - "Consent V2 APIs" - ] - }, - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - }, - "/v2/consents/{consent_id}/fetch/status": { - "get": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK" - } - }, - "summary": "Get last fetch status", - "description": "This API gets the last data fetch status for a consent", - "tags": [ - "Consent V2 APIs" - ] - }, - "parameters": [ - { - "in": "path", - "name": "consent_id", - "required": true, - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - }, - "/v2/sessions": { - "post": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIDataFetchResponseV2" - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateFIDataFetchRequestV2" - } - } - } - }, - "summary": "Create FI data fetch", - "description": "This API is used to initiate a data fetch for FI data.", - "tags": [ - "FI data fetch V2 APIs" - ] - } - }, - "/v2/sessions/{session_id}": { - "get": { - "parameters": [ - { - "in": "header", - "name": "Authorization", - "required": true, - "description": "Authorization Bearer token", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-product-instance-id", - "required": true, - "description": "Product instance ID of FIU", - "schema": { - "type": "string", - "minLength": 1 - } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FIDataFetchResponseV2" - } - } - } - } - }, - "summary": "Get FI data", - "description": "This API gets consent information using request ID.", - "tags": [ - "FI data fetch V2 APIs" - ] - }, - "parameters": [ - { - "in": "path", - "name": "session_id", - "required": true, - "schema": { - "type": "string", - "minLength": 1 - } - } - ] - } - }, - "components": { - "schemas": { - "FIDataFetchResponseV2": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Request identifier to fetch the status and data." - }, - "dataRange": { - "description": "Time range for which the data is being requested", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" - } - ] - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "PENDING", - "COMPLETED", - "EXPIRED", - "FAILED", - "PARTIAL" - ], - "description": "Status for this data fetch session" - }, - "consentId": { - "type": "string", - "format": "uuid", - "description": "Consent identifier for this data fetch request." - }, - "format": { - "type": "string", - "enum": [ - "xml", - "json" - ], - "description": "Format of decrypted data" - }, - "fips": { - "type": "array", - "nullable": true, - "description": "Array of accounts for a particular fip", - "items": { - "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItem1" - } - } - }, - "required": [ - "consentId", - "dataRange", - "fips", - "format", - "id", - "status" - ] - }, - "FIFetchDecrpytedResponseFIItem1": { - "type": "object", - "properties": { - "accounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItemDataItem1" - } - }, - "fipID": { - "type": "string" - } - }, - "required": [ - "accounts", - "fipID" - ] - }, - "FIFetchDecrpytedResponseFIItemDataItem1": { - "type": "object", - "properties": { - "maskedAccNumber": { - "type": "string" - }, - "linkRefNumber": { - "type": "string" - }, - "FIstatus": { - "type": "string" - }, - "data": { - "description": "Contains the decrypted financial information", - "allOf": [ - { - "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItemDataItemData" - } - ] - } - }, - "required": [ - "FIstatus", - "data", - "linkRefNumber", - "maskedAccNumber" - ] - }, - "FIFetchDecrpytedResponseFIItemDataItemData": { - "type": "object", - "properties": {}, - "oneOf": [ - { - "$ref": "#/components/schemas/DepositJSON" - }, - { - "$ref": "#/components/schemas/TermDepositJSON" - }, - { - "$ref": "#/components/schemas/RecurringDepositJSON" - }, - { - "$ref": "#/components/schemas/InsurancePoliciesJSON" - }, - { - "$ref": "#/components/schemas/InsurancePoliciesJSON" - }, - { - "$ref": "#/components/schemas/EquitiesJSON" - }, - { - "$ref": "#/components/schemas/MutualFundsJSON" - }, - { - "$ref": "#/components/schemas/MutualFundsJSON" - }, - { - "$ref": "#/components/schemas/GST" - }, - { - "$ref": "#/components/schemas/ETFJSON" - }, - { - "$ref": "#/components/schemas/XML" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "deposit": "#/components/schemas/DepositJSON", - "term_deposit": "#/components/schemas/TermDepositJSON", - "recurring_deposit": "#/components/schemas/RecurringDepositJSON", - "insurance_policies": "#/components/schemas/InsurancePoliciesJSON", - "insurance": "#/components/schemas/InsurancePoliciesJSON", - "equities": "#/components/schemas/EquitiesJSON", - "mutual_funds": "#/components/schemas/MutualFundsJSON", - "mutualfunds": "#/components/schemas/MutualFundsJSON", - "gstr1_3b": "#/components/schemas/GST", - "etf": "#/components/schemas/ETFJSON", - "xml": "#/components/schemas/XML" - } - } - }, - "XML": { - "type": "object", - "properties": { - "xml": { - "type": "string" - } - } - }, - "ETFJSON": { - "type": "object", - "properties": { - "account": { - "$ref": "#/components/schemas/ETFJSONAccount" - } - } - }, - "ETFJSONAccount": { - "type": "object", - "properties": { - "linkedAccRef": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "maskedDematID": { - "type": "string" - }, - "type": { - "type": "string" - }, - "version": { - "type": "string" - }, - "profile": { - "$ref": "#/components/schemas/ETFJSONAccountProfile" - }, - "summary": { - "$ref": "#/components/schemas/ETFJSONAccountSummary" - }, - "transactions": { - "$ref": "#/components/schemas/ETFJSONAccountTransactions" - } - } - }, - "ETFJSONAccountTransactions": { - "type": "object", - "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "transaction": { - "type": "array", - "nullable": true, - "items": { - "$ref": "#/components/schemas/ETFJSONAccountTransactionsTransaction" - } - } - } - }, - "ETFJSONAccountTransactionsTransaction": { - "type": "object", - "properties": { - "amount": { - "type": "string" - }, - "brokerCode": { - "type": "string" - }, - "isin": { - "type": "string" - }, - "isinDescription": { - "type": "string" - }, - "narration": { - "type": "string" - }, - "nav": { - "type": "string" - }, - "transactionDateTime": { - "type": "string" - }, - "txnId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "units": { - "type": "string" - } - } - }, - "ETFJSONAccountSummary": { - "type": "object", - "properties": { - "investment": { - "$ref": "#/components/schemas/ETFJSONAccountSummaryHoldings" - }, - "currentValue": { - "type": "string" - }, - "investmentValue": { - "type": "string" - } - } - }, - "ETFJSONAccountSummaryHoldings": { - "type": "object", - "properties": { - "holdings": { - "$ref": "#/components/schemas/ETFJSONAccountSummaryHoldingsHolding" - }, - "type": { - "type": "string" - } - } - }, - "ETFJSONAccountSummaryHoldingsHolding": { - "type": "object", - "properties": { - "holding": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ETFJSONAccountSummaryHoldingsHolding" - } - } - } - }, - "ETFJSONAccountProfile": { - "type": "object", - "properties": { - "holders": { - "$ref": "#/components/schemas/ETFJSONAccountProfileHolders" - } - } - }, - "ETFJSONAccountProfileHolders": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "holder": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ETFJSONAccountProfileHoldersHolder" - } - } - } - }, - "ETFJSONAccountProfileHoldersHolder": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "kycCompliance": { - "type": "string" - }, - "dob": { - "type": "string" - }, - "email": { - "type": "string" - }, - "landline": { - "type": "string" - }, - "mobile": { - "type": "string" - }, - "name": { - "type": "string" - }, - "nominee": { - "type": "string" - }, - "pan": { - "type": "string" - }, - "dematId": { - "type": "string" - }, - "boId": { - "type": "string" - }, - "dpId": { - "type": "string" - }, - "brokerName": { - "type": "string" - } - } - }, - "GST": { - "type": "object", - "properties": { - "account": { - "$ref": "#/components/schemas/Account" - } - } - }, - "Account": { - "type": "object", - "properties": { - "linkedAccRef": { - "type": "string" - }, - "maskedGstinNumber": { - "type": "string" - }, - "version": { - "type": "string" - }, - "type": { - "type": "string" - }, - "profile": { - "$ref": "#/components/schemas/Profile" - }, - "transactions": { - "$ref": "#/components/schemas/Transactions" - } - } - }, - "Transactions": { - "type": "object", - "properties": { - "endt": { - "type": "string" - }, - "strdt": { - "type": "string" - }, - "gstr1Details": { - "$ref": "#/components/schemas/Gstr1DetailsSchema1" - }, - "gstr3bDetails": { - "$ref": "#/components/schemas/Gstr3bDetails" - } - } - }, - "Gstr3bDetails": { - "type": "object", - "properties": { - "gstr3b": { - "$ref": "#/components/schemas/Gstr3b" - } - } - }, - "Gstr3b": { - "type": "object", - "properties": { - "retPrd": { - "type": "string" - }, - "dof": { - "type": "string" - }, - "status": { - "type": "string" - }, - "filingFrequency": { - "type": "string" - }, - "supDetails": { - "$ref": "#/components/schemas/SupDetail" - }, - "supInter": { - "$ref": "#/components/schemas/SupInterSchemaWrapper" - }, - "ecoDtls": { - "$ref": "#/components/schemas/EcoSup" - }, - "itcElg": { - "$ref": "#/components/schemas/ItcEligible" - }, - "inwardSup": { - "$ref": "#/components/schemas/ISupDetails" - }, - "intrLtfee": { - "$ref": "#/components/schemas/IntrLtfee" - }, - "txPmt": { - "$ref": "#/components/schemas/TxPyList" - }, - "pdcashDtls": { - "$ref": "#/components/schemas/PdCashLists" - } - } - }, - "PdCashLists": { - "type": "object", - "properties": { - "pdcashList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PdcashDetails" - } - }, - "pditc": { - "$ref": "#/components/schemas/Pditc" - } - } - }, - "Pditc": { - "type": "object", - "properties": { - "transDesc": { - "type": "string" - }, - "iPdi": { - "type": "string" - }, - "iPdc": { - "type": "string" - }, - "iPds": { - "type": "string" - }, - "cPdi": { - "type": "string" - }, - "cPdc": { - "type": "string" - }, - "sPdi": { - "type": "string" - }, - "sPds": { - "type": "string" - }, - "csPdcs": { - "type": "string" - } - } - }, - "PdcashDetails": { - "type": "object", - "properties": { - "pdcash": { - "$ref": "#/components/schemas/Pdcash" - } - } - }, - "Pdcash": { - "type": "object", - "properties": { - "transDesc": { - "type": "string" - }, - "ipd": { - "type": "string" - }, - "cpd": { - "type": "string" - }, - "spd": { - "type": "string" - }, - "cspd": { - "type": "string" - }, - "iIntrpd": { - "type": "string" - }, - "cIntrpd": { - "type": "string" - }, - "sIntrpd": { - "type": "string" - }, - "csIntrpd": { - "type": "string" + ] }, - "cLfeepd": { - "type": "string" + "id": { + "type": "string", + "format": "uuid", + "description": "Request identifier to fetch the status and data." }, - "sLfeepd": { - "type": "string" - } - } - }, - "TxPyList": { - "type": "object", - "properties": { - "txPyList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TxPy" - } - } - } - }, - "TxPy": { - "type": "object", - "properties": { - "txPy": { - "$ref": "#/components/schemas/TxPy" + "format": { + "type": "string", + "enum": [ + "xml", + "json" + ], + "description": "Format of decrypted data" } - } + }, + "required": [ + "consentId", + "dataRange", + "fips", + "format", + "id", + "status" + ] }, - "IntrLtfee": { + "ConsentsRequestConsentDetailFIDataRange": { "type": "object", "properties": { - "intrDetails": { - "$ref": "#/components/schemas/IntrDetails" + "to": { + "type": "string", + "format": "date-time", + "description": "Selects the ending date-time from where the financial information is to be end. It is a mandatory field only if consentTypes includes ENUM TRANSACTIONS in consent parameters." }, - "ltfeeDetails": { - "$ref": "#/components/schemas/IntrDetails" + "from": { + "type": "string", + "format": "date-time", + "description": "Selects the starting date-time from where the financial information is to be start. It is a mandatory field only if consentTypes includes ENUM TRANSACTIONS in consent parameters." } - } + }, + "required": [ + "from", + "to" + ] }, - "IntrDetails": { + "FIFetchDecrpytedResponseFIItem1": { "type": "object", "properties": { - "iamt": { - "type": "string" - }, - "camt": { - "type": "string" - }, - "samt": { + "fipID": { "type": "string" }, - "csamt": { - "type": "string" - } - } - }, - "ISupDetails": { - "type": "object", - "properties": { - "isupDetailsList": { - "$ref": "#/components/schemas/IsupDetailsList" - } - } - }, - "IsupDetailsList": { - "type": "object", - "properties": { - "isupDetails": { + "accounts": { "type": "array", "items": { - "$ref": "#/components/schemas/IsupDetails" + "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItemDataItem1" } } - } + }, + "required": [ + "accounts", + "fipID" + ] }, - "IsupDetails": { + "FIFetchDecrpytedResponseFIItemDataItem1": { "type": "object", "properties": { - "ty": { + "maskedAccNumber": { "type": "string" }, - "inter": { + "data": { + "description": "Contains the decrypted financial information", + "allOf": [ + { + "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItemDataItemData" + } + ] + }, + "linkRefNumber": { "type": "string" }, - "intra": { + "FIstatus": { "type": "string" } - } + }, + "required": [ + "FIstatus", + "data", + "linkRefNumber", + "maskedAccNumber" + ] }, - "ItcEligible": { + "FIFetchDecrpytedResponseFIItemDataItemData": { "type": "object", - "properties": { - "itcAvlList": { - "$ref": "#/components/schemas/ItcAvlList" + "properties": {}, + "oneOf": [ + { + "$ref": "#/components/schemas/DepositJSON" }, - "itcRevList": { - "$ref": "#/components/schemas/ItcRevList" + { + "$ref": "#/components/schemas/TermDepositJSON" }, - "itcNet": { - "$ref": "#/components/schemas/ItcRev" + { + "$ref": "#/components/schemas/RecurringDepositJSON" }, - "itcInelgList": { - "$ref": "#/components/schemas/ItcInelgList" - } - } - }, - "ItcInelgList": { - "type": "object", - "properties": { - "itcInelg": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ItcRev" - } - } - } - }, - "ItcRev": { - "type": "object", - "properties": { - "type": { - "type": "string" + { + "$ref": "#/components/schemas/InsurancePoliciesJSON" }, - "iamt": { - "type": "string" + { + "$ref": "#/components/schemas/InsurancePoliciesJSON" }, - "camt": { - "type": "string" + { + "$ref": "#/components/schemas/EquitiesJSON" }, - "samt": { - "type": "string" + { + "$ref": "#/components/schemas/MutualFundsJSON" }, - "csamt": { - "type": "string" + { + "$ref": "#/components/schemas/MutualFundsJSON" + }, + { + "$ref": "#/components/schemas/GST" + }, + { + "$ref": "#/components/schemas/ETFJSON" + }, + { + "$ref": "#/components/schemas/XML" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "deposit": "#/components/schemas/DepositJSON", + "term_deposit": "#/components/schemas/TermDepositJSON", + "recurring_deposit": "#/components/schemas/RecurringDepositJSON", + "insurance_policies": "#/components/schemas/InsurancePoliciesJSON", + "insurance": "#/components/schemas/InsurancePoliciesJSON", + "equities": "#/components/schemas/EquitiesJSON", + "mutual_funds": "#/components/schemas/MutualFundsJSON", + "mutualfunds": "#/components/schemas/MutualFundsJSON", + "gstr1_3b": "#/components/schemas/GST", + "etf": "#/components/schemas/ETFJSON", + "xml": "#/components/schemas/XML" } } }, - "ItcRevList": { + "XML": { "type": "object", "properties": { - "itcRev": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ItcRev" - } + "xml": { + "type": "string" } } }, - "ItcAvlList": { + "ETFJSON": { "type": "object", "properties": { - "itcAvl": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ItcAvl" - } + "account": { + "$ref": "#/components/schemas/ETFJSONAccount" } } }, - "ItcAvl": { + "ETFJSONAccount": { "type": "object", "properties": { - "type": { + "linkedAccRef": { "type": "string" }, - "iamt": { + "maskedAccNumber": { "type": "string" }, - "camt": { + "maskedDematID": { "type": "string" }, - "samt": { + "type": { "type": "string" }, - "csamt": { + "version": { "type": "string" - } - } - }, - "EcoSup": { - "type": "object", - "properties": { - "ecoSup": { - "$ref": "#/components/schemas/EcoSup" - }, - "ecoRegSup": { - "$ref": "#/components/schemas/EcoSup" - } - } - }, - "SupInterSchemaWrapper": { - "type": "object", - "properties": { - "unregDetailsList": { - "$ref": "#/components/schemas/SupInter" - }, - "compDetailsList": { - "$ref": "#/components/schemas/SupInter" }, - "uinDetailsList": { - "$ref": "#/components/schemas/SupInter" - } - } - }, - "SupInter": { - "type": "object", - "properties": { - "unregDetails": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupInterDetails" - } + "profile": { + "$ref": "#/components/schemas/ETFJSONAccountProfile" }, - "compDetails": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupInterDetails" - } + "summary": { + "$ref": "#/components/schemas/ETFJSONAccountSummary" }, - "uinDetails": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupInterDetails" - } + "transactions": { + "$ref": "#/components/schemas/ETFJSONAccountTransactions" } } }, - "SupInterDetails": { + "ETFJSONAccountTransactions": { "type": "object", "properties": { - "txval": { + "startDate": { "type": "string" }, - "iamt": { + "endDate": { "type": "string" }, - "pos": { - "type": "string" + "transaction": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/ETFJSONAccountTransactionsTransaction" + } } } }, - "SupDetail": { + "ETFJSONAccountTransactionsTransaction": { "type": "object", "properties": { - "osupDet": { - "$ref": "#/components/schemas/SupDetails" + "amount": { + "type": "string" }, - "osupZero": { - "$ref": "#/components/schemas/SupDetails" + "brokerCode": { + "type": "string" }, - "osupNilExmp": { - "$ref": "#/components/schemas/SupDetails" + "isin": { + "type": "string" }, - "isupRev": { - "$ref": "#/components/schemas/SupDetails" + "isinDescription": { + "type": "string" }, - "osupNongst": { - "$ref": "#/components/schemas/SupDetails" - } - } - }, - "SupDetails": { - "type": "object", - "properties": { - "txval": { + "narration": { "type": "string" }, - "iamt": { + "nav": { "type": "string" }, - "camt": { + "transactionDateTime": { "type": "string" }, - "samt": { + "txnId": { "type": "string" }, - "csamt": { + "type": { + "type": "string" + }, + "units": { "type": "string" } } }, - "Gstr1DetailsSchema1": { - "type": "object", - "properties": { - "gstr1": { - "$ref": "#/components/schemas/Gstr1Details" - } - } - }, - "Gstr1Details": { + "ETFJSONAccountSummary": { "type": "object", "properties": { - "dof": { - "type": "string" - }, - "filingFrequency": { - "type": "string" + "investment": { + "$ref": "#/components/schemas/ETFJSONAccountSummaryHoldings" }, - "retPrd": { + "currentValue": { "type": "string" }, - "status": { + "investmentValue": { "type": "string" - }, - "b2bDtls": { - "$ref": "#/components/schemas/B2B" } } }, - "B2B": { + "ETFJSONAccountSummaryHoldings": { "type": "object", "properties": { - "b2b": { - "$ref": "#/components/schemas/B2B" + "holdings": { + "$ref": "#/components/schemas/ETFJSONAccountSummaryHoldingsHolding" + }, + "type": { + "type": "string" } } }, - "Profile": { + "ETFJSONAccountSummaryHoldingsHolding": { "type": "object", "properties": { - "businessDetails": { - "$ref": "#/components/schemas/BusinessDetails" - }, - "placeofBusiness": { - "$ref": "#/components/schemas/PlaceofBusiness" + "holding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ETFJSONAccountSummaryHoldingsHolding" + } } } }, - "PlaceofBusiness": { + "ETFJSONAccountProfile": { "type": "object", "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "natureOfBusinessList": { - "$ref": "#/components/schemas/NatureOfBusinessList" + "holders": { + "$ref": "#/components/schemas/ETFJSONAccountProfileHolders" } } }, - "NatureOfBusinessList": { + "ETFJSONAccountProfileHolders": { "type": "object", "properties": { - "ntr": { + "type": { + "type": "string" + }, + "holder": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ETFJSONAccountProfileHoldersHolder" } } } }, - "Address": { + "ETFJSONAccountProfileHoldersHolder": { "type": "object", "properties": { - "bnm": { + "address": { "type": "string" }, - "bno": { + "kycCompliance": { "type": "string" }, - "dst": { + "dob": { "type": "string" }, - "flno": { + "email": { "type": "string" }, - "loc": { + "landline": { "type": "string" }, - "pncd": { + "mobile": { "type": "string" }, - "st": { + "name": { "type": "string" }, - "stcd": { + "nominee": { + "type": "string" + }, + "pan": { + "type": "string" + }, + "dematId": { + "type": "string" + }, + "boId": { + "type": "string" + }, + "dpId": { + "type": "string" + }, + "brokerName": { "type": "string" } } }, - "BusinessDetails": { + "GST": { "type": "object", "properties": { - "apprvdt": { - "type": "string" - }, - "lgnm": { + "account": { + "$ref": "#/components/schemas/Account" + } + } + }, + "Account": { + "type": "object", + "properties": { + "linkedAccRef": { "type": "string" }, - "dty": { + "maskedGstinNumber": { "type": "string" }, - "iscmp": { + "version": { "type": "string" }, - "sts": { + "type": { "type": "string" }, - "trdnm": { - "type": "string" + "profile": { + "$ref": "#/components/schemas/Profile" }, - "categoryList": { - "$ref": "#/components/schemas/CategoryList" + "transactions": { + "$ref": "#/components/schemas/Transactions" } } }, - "CategoryList": { + "Transactions": { "type": "object", "properties": { - "cat": { - "type": "array", - "items": { - "type": "string" - } + "endt": { + "type": "string" + }, + "strdt": { + "type": "string" + }, + "gstr1Details": { + "$ref": "#/components/schemas/Gstr1DetailsSchema1" + }, + "gstr3bDetails": { + "$ref": "#/components/schemas/Gstr3bDetails" } } }, - "MutualFundsJSON": { + "Gstr3bDetails": { "type": "object", "properties": { - "account": { - "$ref": "#/components/schemas/MutualFundJSON" + "gstr3b": { + "$ref": "#/components/schemas/Gstr3b" } } }, - "MutualFundJSON": { + "Gstr3b": { "type": "object", "properties": { - "linkedAccRef": { + "retPrd": { "type": "string" }, - "maskedAccNumber": { + "dof": { "type": "string" }, - "type": { + "status": { "type": "string" }, - "version": { + "filingFrequency": { "type": "string" }, - "maskedDematID": { - "type": "string" + "supDetails": { + "$ref": "#/components/schemas/SupDetail" }, - "maskedFolioNo": { - "type": "string" + "supInter": { + "$ref": "#/components/schemas/SupInterSchemaWrapper" }, - "profile": { - "$ref": "#/components/schemas/MutualFundJSONSchemaProfile" + "ecoDtls": { + "$ref": "#/components/schemas/EcoSup" }, - "summary": { - "$ref": "#/components/schemas/MutualFundJSONSchemaSummary" + "itcElg": { + "$ref": "#/components/schemas/ItcEligible" }, - "transactions": { - "$ref": "#/components/schemas/MutualFundJSONSchemaTransactions" + "inwardSup": { + "$ref": "#/components/schemas/ISupDetails" + }, + "intrLtfee": { + "$ref": "#/components/schemas/IntrLtfee" + }, + "txPmt": { + "$ref": "#/components/schemas/TxPyList" + }, + "pdcashDtls": { + "$ref": "#/components/schemas/PdCashLists" } } }, - "MutualFundJSONSchemaTransactions": { + "PdCashLists": { "type": "object", "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "transaction": { + "pdcashList": { "type": "array", - "nullable": true, "items": { - "$ref": "#/components/schemas/MutualFundJSONSchemaTransactionsTransaction" + "$ref": "#/components/schemas/PdcashDetails" } + }, + "pditc": { + "$ref": "#/components/schemas/Pditc" } } }, - "MutualFundJSONSchemaTransactionsTransaction": { + "Pditc": { "type": "object", "properties": { - "amc": { - "type": "string" - }, - "registrar": { - "type": "string" - }, - "schemeCode": { + "transDesc": { "type": "string" }, - "schemePlan": { + "iPdi": { "type": "string" }, - "isin": { + "iPdc": { "type": "string" }, - "amfiCode": { + "iPds": { "type": "string" }, - "ucc": { + "cPdi": { "type": "string" }, - "amount": { + "cPdc": { "type": "string" }, - "nav": { + "sPdi": { "type": "string" }, - "navDate": { + "sPds": { "type": "string" }, - "type": { + "csPdcs": { "type": "string" - }, - "lock-inFlag": { + } + } + }, + "PdcashDetails": { + "type": "object", + "properties": { + "pdcash": { + "$ref": "#/components/schemas/Pdcash" + } + } + }, + "Pdcash": { + "type": "object", + "properties": { + "transDesc": { "type": "string" }, - "lock-inDays": { + "ipd": { "type": "string" }, - "mode": { + "cpd": { "type": "string" }, - "narration": { + "spd": { "type": "string" }, - "txnId": { + "cspd": { "type": "string" }, - "isinDescription": { + "iIntrpd": { "type": "string" }, - "units": { + "cIntrpd": { "type": "string" }, - "transactionDate": { + "sIntrpd": { "type": "string" - } - } - }, - "MutualFundJSONSchemaSummary": { - "type": "object", - "properties": { - "investment": { - "$ref": "#/components/schemas/MutualFundJSONSchemaSummaryHoldings" }, - "costValue": { + "csIntrpd": { "type": "string" }, - "currentValue": { + "cLfeepd": { "type": "string" - } - } - }, - "MutualFundJSONSchemaSummaryHoldings": { - "type": "object", - "properties": { - "holdings": { - "$ref": "#/components/schemas/MutualFundJSONSchemaSummaryHoldingsHolding" }, - "type": { + "sLfeepd": { "type": "string" } } }, - "MutualFundJSONSchemaSummaryHoldingsHolding": { + "TxPyList": { "type": "object", "properties": { - "holding": { + "txPyList": { "type": "array", "items": { - "$ref": "#/components/schemas/MutualFundJSONSchemaSummaryHoldingsHolding" + "$ref": "#/components/schemas/TxPy" } } } }, - "MutualFundJSONSchemaProfile": { + "TxPy": { "type": "object", "properties": { - "holders": { - "$ref": "#/components/schemas/MutualFundJSONSchemaProfileHolders" + "txPy": { + "$ref": "#/components/schemas/TxPy" } } }, - "MutualFundJSONSchemaProfileHolders": { + "IntrLtfee": { "type": "object", "properties": { - "type": { - "type": "string" + "intrDetails": { + "$ref": "#/components/schemas/IntrDetails" }, - "holder": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MutualFundJSONSchemaProfileHoldersHolder" - } + "ltfeeDetails": { + "$ref": "#/components/schemas/IntrDetails" } } }, - "MutualFundJSONSchemaProfileHoldersHolder": { + "IntrDetails": { "type": "object", "properties": { - "address": { - "type": "string" - }, - "kycCompliance": { - "type": "string" - }, - "dob": { - "type": "string" - }, - "email": { - "type": "string" - }, - "landline": { - "type": "string" - }, - "mobile": { - "type": "string" - }, - "name": { - "type": "string" - }, - "nominee": { + "iamt": { "type": "string" }, - "pan": { + "camt": { "type": "string" }, - "dematId": { + "samt": { "type": "string" }, - "folioNo": { + "csamt": { "type": "string" } } }, - "EquitiesJSON": { + "ISupDetails": { "type": "object", "properties": { - "account": { - "$ref": "#/components/schemas/EquitiesJSONAccount" + "isupDetailsList": { + "$ref": "#/components/schemas/IsupDetailsList" } } }, - "EquitiesJSONAccount": { + "IsupDetailsList": { "type": "object", "properties": { - "linkedAccRef": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "type": { - "type": "string" - }, - "version": { - "type": "string" - }, - "profile": { - "$ref": "#/components/schemas/EquitiesJSONAccountProfile" - }, - "summary": { - "$ref": "#/components/schemas/EquitiesJSONAccountSummary" - }, - "transactions": { - "$ref": "#/components/schemas/EquitiesJSONAccountTransactions" + "isupDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IsupDetails" + } } } }, - "EquitiesJSONAccountTransactions": { + "IsupDetails": { "type": "object", "properties": { - "startDate": { + "ty": { "type": "string" }, - "endDate": { + "inter": { "type": "string" }, - "transaction": { - "type": "array", - "nullable": true, - "items": { - "$ref": "#/components/schemas/EquitiesJSONAccountTransactionsTransaction" - } + "intra": { + "type": "string" } } }, - "EquitiesJSONAccountTransactionsTransaction": { + "ItcEligible": { "type": "object", "properties": { - "companyName": { - "type": "string" - }, - "equityCategory": { - "type": "string" - }, - "exchange": { - "type": "string" - }, - "instrumentType": { - "type": "string" - }, - "isin": { - "type": "string" - }, - "narration": { - "type": "string" - }, - "optionType": { - "type": "string" - }, - "orderId": { - "type": "string" - }, - "otherCharges": { - "type": "string" - }, - "rate": { - "type": "string" - }, - "shareHolderEquityType": { - "type": "string" - }, - "strikePrice": { - "type": "string" - }, - "symbol": { - "type": "string" - }, - "totalCharge": { - "type": "string" - }, - "tradeValue": { - "type": "string" - }, - "transactionDateTime": { - "type": "string" + "itcAvlList": { + "$ref": "#/components/schemas/ItcAvlList" }, - "txnId": { - "type": "string" + "itcRevList": { + "$ref": "#/components/schemas/ItcRevList" }, - "type": { - "type": "string" + "itcNet": { + "$ref": "#/components/schemas/ItcRev" }, - "units": { - "type": "string" + "itcInelgList": { + "$ref": "#/components/schemas/ItcInelgList" + } + } + }, + "ItcInelgList": { + "type": "object", + "properties": { + "itcInelg": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ItcRev" + } } } }, - "EquitiesJSONAccountSummary": { + "ItcRev": { "type": "object", "properties": { - "investment": { - "$ref": "#/components/schemas/EquitiesJSONAccountSummaryHoldings" + "type": { + "type": "string" }, - "currentValue": { + "iamt": { "type": "string" }, - "investmentValue": { + "camt": { "type": "string" - } - } - }, - "EquitiesJSONAccountSummaryHoldings": { - "type": "object", - "properties": { - "holdings": { - "$ref": "#/components/schemas/EquitiesJSONAccountSummaryHoldingsHolding" }, - "type": { + "samt": { + "type": "string" + }, + "csamt": { "type": "string" } } }, - "EquitiesJSONAccountSummaryHoldingsHolding": { + "ItcRevList": { "type": "object", "properties": { - "holding": { + "itcRev": { "type": "array", "items": { - "$ref": "#/components/schemas/EquitiesJSONAccountSummaryHoldingsHolding" + "$ref": "#/components/schemas/ItcRev" } } } }, - "EquitiesJSONAccountProfile": { - "type": "object", - "properties": { - "holders": { - "$ref": "#/components/schemas/EquitiesJSONAccountProfileHolders" - } - } - }, - "EquitiesJSONAccountProfileHolders": { + "ItcAvlList": { "type": "object", "properties": { - "type": { - "type": "string" - }, - "holder": { + "itcAvl": { "type": "array", "items": { - "$ref": "#/components/schemas/EquitiesJSONAccountProfileHoldersHolder" + "$ref": "#/components/schemas/ItcAvl" } } } }, - "EquitiesJSONAccountProfileHoldersHolder": { + "ItcAvl": { "type": "object", "properties": { - "address": { - "type": "string" - }, - "ckycCompliance": { - "type": "string" - }, - "dob": { - "type": "string" - }, - "email": { - "type": "string" - }, - "landline": { - "type": "string" - }, - "mobile": { - "type": "string" - }, - "name": { - "type": "string" - }, - "nominee": { - "type": "string" - }, - "pan": { - "type": "string" - }, - "rank": { + "type": { "type": "string" }, - "dematId": { + "iamt": { "type": "string" }, - "boId": { + "camt": { "type": "string" }, - "dpId": { + "samt": { "type": "string" }, - "brokerName": { + "csamt": { "type": "string" } } }, - "InsurancePoliciesJSON": { + "EcoSup": { "type": "object", "properties": { - "account": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccount" + "ecoSup": { + "$ref": "#/components/schemas/EcoSup" + }, + "ecoRegSup": { + "$ref": "#/components/schemas/EcoSup" } } }, - "InsurancePoliciesJSONAccount": { + "SupInterSchemaWrapper": { "type": "object", "properties": { - "linkedAccRef": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "type": { - "type": "string" - }, - "version": { - "type": "string" - }, - "profile": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfile" + "unregDetailsList": { + "$ref": "#/components/schemas/SupInter" }, - "summary": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummary" + "compDetailsList": { + "$ref": "#/components/schemas/SupInter" }, - "transactions": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountTransactions" + "uinDetailsList": { + "$ref": "#/components/schemas/SupInter" } } }, - "InsurancePoliciesJSONAccountTransactions": { + "SupInter": { "type": "object", "properties": { - "startDate": { - "type": "string" + "unregDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SupInterDetails" + } }, - "endDate": { - "type": "string" + "compDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SupInterDetails" + } }, - "transaction": { + "uinDetails": { "type": "array", - "nullable": true, "items": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountTransactionsTransaction" + "$ref": "#/components/schemas/SupInterDetails" } } } }, - "InsurancePoliciesJSONAccountTransactionsTransaction": { + "SupInterDetails": { "type": "object", "properties": { - "amount": { - "type": "string" - }, - "narration": { - "type": "string" - }, - "txnId": { + "txval": { "type": "string" }, - "type": { + "iamt": { "type": "string" }, - "txnDate": { + "pos": { "type": "string" } } }, - "InsurancePoliciesJSONAccountSummary": { + "SupDetail": { "type": "object", "properties": { - "contractClauses": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryContractClauses" - }, - "covers": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryCover" - }, - "moneyBacks": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountMoneyBack" - }, - "coverAmount": { - "type": "string" - }, - "coverType": { - "type": "string" - }, - "eiaNumber": { - "type": "string" - }, - "maturityBenefit": { - "type": "string" - }, - "maturityDate": { - "type": "string" - }, - "policyName": { - "type": "string" - }, - "policyNumber": { - "type": "string" - }, - "policyStartDate": { - "type": "string" + "osupDet": { + "$ref": "#/components/schemas/SupDetails" }, - "policyType": { - "type": "string" + "osupZero": { + "$ref": "#/components/schemas/SupDetails" }, - "premiumAmount": { - "type": "string" + "osupNilExmp": { + "$ref": "#/components/schemas/SupDetails" }, - "premiumFrequency": { - "type": "string" + "isupRev": { + "$ref": "#/components/schemas/SupDetails" }, - "premiumPaymentMonths": { + "osupNongst": { + "$ref": "#/components/schemas/SupDetails" + } + } + }, + "SupDetails": { + "type": "object", + "properties": { + "txval": { "type": "string" }, - "premiumPaymentYears": { + "iamt": { "type": "string" }, - "sumAssured": { + "camt": { "type": "string" }, - "tenureMonths": { + "samt": { "type": "string" }, - "tenureYears": { + "csamt": { "type": "string" } } }, - "InsurancePoliciesJSONAccountMoneyBack": { - "type": "object", - "properties": { - "MoneyBack": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountMoneyBack" - } - } - } - }, - "InsurancePoliciesJSONAccountSummaryCover": { - "type": "object", - "properties": { - "cover": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryCover" - } - } - } - }, - "InsurancePoliciesJSONAccountSummaryContractClauses": { + "Gstr1DetailsSchema1": { "type": "object", "properties": { - "contractClause": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryContractClause" - } + "gstr1": { + "$ref": "#/components/schemas/Gstr1Details" } } }, - "InsurancePoliciesJSONAccountSummaryContractClause": { + "Gstr1Details": { "type": "object", "properties": { - "amount": { + "dof": { "type": "string" }, - "conditions": { + "filingFrequency": { "type": "string" }, - "description": { + "retPrd": { "type": "string" }, - "exlcusions": { + "status": { "type": "string" }, - "subLimit": { - "type": "string" + "b2bDtls": { + "$ref": "#/components/schemas/B2B" + } + } + }, + "B2B": { + "type": "object", + "properties": { + "b2b": { + "$ref": "#/components/schemas/B2B" + } + } + }, + "Profile": { + "type": "object", + "properties": { + "businessDetails": { + "$ref": "#/components/schemas/BusinessDetails" }, - "title": { - "type": "string" + "placeofBusiness": { + "$ref": "#/components/schemas/PlaceofBusiness" } } }, - "InsurancePoliciesJSONAccountProfile": { + "PlaceofBusiness": { "type": "object", "properties": { - "holders": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfileHolders" + "address": { + "$ref": "#/components/schemas/Address" }, - "riders": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountRiders" + "natureOfBusinessList": { + "$ref": "#/components/schemas/NatureOfBusinessList" } } }, - "InsurancePoliciesJSONAccountRiders": { + "NatureOfBusinessList": { "type": "object", "properties": { - "rider": { + "ntr": { "type": "array", "items": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfileRidersRider" + "type": "string" } } } }, - "InsurancePoliciesJSONAccountProfileRidersRider": { + "Address": { "type": "object", "properties": { - "policyEndDate": { + "bnm": { "type": "string" }, - "policyStartDate": { + "bno": { "type": "string" }, - "premiumAmount": { + "dst": { "type": "string" }, - "riderType": { + "flno": { "type": "string" }, - "sumAssured": { + "loc": { "type": "string" }, - "tenureMonths": { + "pncd": { "type": "string" }, - "tenureYears": { - "type": "string" - } - } - }, - "InsurancePoliciesJSONAccountProfileHolders": { - "type": "object", - "properties": { - "type": { + "st": { "type": "string" }, - "holder": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfileHoldersHolder" - } + "stcd": { + "type": "string" } } }, - "InsurancePoliciesJSONAccountProfileHoldersHolder": { + "BusinessDetails": { "type": "object", "properties": { - "address": { - "type": "string" - }, - "ckycCompliance": { - "type": "string" - }, - "dob": { - "type": "string" - }, - "email": { + "apprvdt": { "type": "string" }, - "landline": { + "lgnm": { "type": "string" }, - "mobile": { + "dty": { "type": "string" }, - "name": { + "iscmp": { "type": "string" }, - "nominee": { + "sts": { "type": "string" }, - "pan": { + "trdnm": { "type": "string" }, - "rank": { - "type": "string" + "categoryList": { + "$ref": "#/components/schemas/CategoryList" } } }, - "RecurringDepositJSON": { + "CategoryList": { + "type": "object", + "properties": { + "cat": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MutualFundsJSON": { "type": "object", "properties": { "account": { - "$ref": "#/components/schemas/RecurringDepositJSONAccount" + "$ref": "#/components/schemas/MutualFundJSON" } } }, - "RecurringDepositJSONAccount": { + "MutualFundJSON": { "type": "object", "properties": { "linkedAccRef": { @@ -2966,18 +1551,24 @@ "version": { "type": "string" }, + "maskedDematID": { + "type": "string" + }, + "maskedFolioNo": { + "type": "string" + }, "profile": { - "$ref": "#/components/schemas/RecurringDepositJSONAccountProfile" + "$ref": "#/components/schemas/MutualFundJSONSchemaProfile" }, "summary": { - "$ref": "#/components/schemas/RecurringDepositJSONAccountSummary" + "$ref": "#/components/schemas/MutualFundJSONSchemaSummary" }, "transactions": { - "$ref": "#/components/schemas/RecurringDepositJSONAccountTransactions" + "$ref": "#/components/schemas/MutualFundJSONSchemaTransactions" } } }, - "RecurringDepositJSONAccountTransactions": { + "MutualFundJSONSchemaTransactions": { "type": "object", "properties": { "startDate": { @@ -2990,117 +1581,118 @@ "type": "array", "nullable": true, "items": { - "$ref": "#/components/schemas/RecurringDepositJSONAccountTransactionsTransaction" + "$ref": "#/components/schemas/MutualFundJSONSchemaTransactionsTransaction" } } } }, - "RecurringDepositJSONAccountTransactionsTransaction": { + "MutualFundJSONSchemaTransactionsTransaction": { "type": "object", "properties": { - "amount": { - "type": "string" - }, - "currentBalance": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "narration": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "transactionTimestamp": { - "type": "string" - }, - "txnId": { + "amc": { "type": "string" }, - "type": { + "registrar": { "type": "string" }, - "valueDate": { - "type": "string" - } - } - }, - "RecurringDepositJSONAccountSummary": { - "type": "object", - "properties": { - "accountType": { + "schemeCode": { "type": "string" }, - "branch": { + "schemePlan": { "type": "string" }, - "compoundingFrequency": { + "isin": { "type": "string" }, - "currentValue": { + "amfiCode": { "type": "string" }, - "description": { + "ucc": { "type": "string" }, - "ifsc": { + "amount": { "type": "string" }, - "interestComputation": { + "nav": { "type": "string" }, - "interestOnMaturity": { + "navDate": { "type": "string" }, - "interestPayout": { + "type": { "type": "string" }, - "interestPeriodicPayoutAmount": { + "lock-inFlag": { "type": "string" }, - "interestRate": { + "lock-inDays": { "type": "string" }, - "maturityAmount": { + "mode": { "type": "string" }, - "maturityDate": { + "narration": { "type": "string" }, - "openingDate": { + "txnId": { "type": "string" }, - "principalAmount": { + "isinDescription": { "type": "string" }, - "recurringAmount": { + "units": { "type": "string" }, - "recurringDepositDay": { + "transactionDate": { "type": "string" + } + } + }, + "MutualFundJSONSchemaSummary": { + "type": "object", + "properties": { + "investment": { + "$ref": "#/components/schemas/MutualFundJSONSchemaSummaryHoldings" }, - "tenureDays": { + "costValue": { "type": "string" }, - "tenureMonths": { + "currentValue": { "type": "string" + } + } + }, + "MutualFundJSONSchemaSummaryHoldings": { + "type": "object", + "properties": { + "holdings": { + "$ref": "#/components/schemas/MutualFundJSONSchemaSummaryHoldingsHolding" }, - "tenureYears": { + "type": { "type": "string" } } }, - "RecurringDepositJSONAccountProfile": { + "MutualFundJSONSchemaSummaryHoldingsHolding": { + "type": "object", + "properties": { + "holding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MutualFundJSONSchemaSummaryHoldingsHolding" + } + } + } + }, + "MutualFundJSONSchemaProfile": { "type": "object", "properties": { "holders": { - "$ref": "#/components/schemas/RecurringDepositJSONAccountProfileHolders" + "$ref": "#/components/schemas/MutualFundJSONSchemaProfileHolders" } } }, - "RecurringDepositJSONAccountProfileHolders": { + "MutualFundJSONSchemaProfileHolders": { "type": "object", "properties": { "type": { @@ -3109,18 +1701,18 @@ "holder": { "type": "array", "items": { - "$ref": "#/components/schemas/RecurringDepositJSONAccountProfileHoldersHolder" + "$ref": "#/components/schemas/MutualFundJSONSchemaProfileHoldersHolder" } } } }, - "RecurringDepositJSONAccountProfileHoldersHolder": { + "MutualFundJSONSchemaProfileHoldersHolder": { "type": "object", "properties": { "address": { "type": "string" }, - "ckycCompliance": { + "kycCompliance": { "type": "string" }, "dob": { @@ -3141,20 +1733,26 @@ "nominee": { "type": "string" }, - "pan": { + "pan": { + "type": "string" + }, + "dematId": { + "type": "string" + }, + "folioNo": { "type": "string" } } }, - "TermDepositJSON": { + "EquitiesJSON": { "type": "object", "properties": { "account": { - "$ref": "#/components/schemas/TermDepositJSONAccount" + "$ref": "#/components/schemas/EquitiesJSONAccount" } } }, - "TermDepositJSONAccount": { + "EquitiesJSONAccount": { "type": "object", "properties": { "linkedAccRef": { @@ -3170,17 +1768,17 @@ "type": "string" }, "profile": { - "$ref": "#/components/schemas/TermDepositJSONAccountProfile" + "$ref": "#/components/schemas/EquitiesJSONAccountProfile" }, "summary": { - "$ref": "#/components/schemas/TermDepositJSONAccountSummary" + "$ref": "#/components/schemas/EquitiesJSONAccountSummary" }, "transactions": { - "$ref": "#/components/schemas/TermDepositJSONAccountTransactions" + "$ref": "#/components/schemas/EquitiesJSONAccountTransactions" } } }, - "TermDepositJSONAccountTransactions": { + "EquitiesJSONAccountTransactions": { "type": "object", "properties": { "startDate": { @@ -3193,117 +1791,118 @@ "type": "array", "nullable": true, "items": { - "$ref": "#/components/schemas/TermDepositJSONAccountTransactionsTransaction" + "$ref": "#/components/schemas/EquitiesJSONAccountTransactionsTransaction" } } } }, - "TermDepositJSONAccountTransactionsTransaction": { + "EquitiesJSONAccountTransactionsTransaction": { "type": "object", "properties": { - "amount": { - "type": "string" - }, - "currentBalance": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "narration": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "transactionTimestamp": { - "type": "string" - }, - "txnId": { + "companyName": { "type": "string" }, - "type": { + "equityCategory": { "type": "string" }, - "valueDate": { - "type": "string" - } - } - }, - "TermDepositJSONAccountSummary": { - "type": "object", - "properties": { - "accountType": { + "exchange": { "type": "string" }, - "branch": { + "instrumentType": { "type": "string" }, - "compoundingFrequency": { + "isin": { "type": "string" }, - "currentValue": { + "narration": { "type": "string" }, - "description": { + "optionType": { "type": "string" }, - "ifsc": { + "orderId": { "type": "string" }, - "interestComputation": { + "otherCharges": { "type": "string" }, - "interestOnMaturity": { + "rate": { "type": "string" }, - "interestPayout": { + "shareHolderEquityType": { "type": "string" }, - "interestPeriodicPayoutAmount": { + "strikePrice": { "type": "string" }, - "interestRate": { + "symbol": { "type": "string" }, - "maturityAmount": { + "totalCharge": { "type": "string" }, - "maturityDate": { + "tradeValue": { "type": "string" }, - "openingDate": { + "transactionDateTime": { "type": "string" }, - "principalAmount": { + "txnId": { "type": "string" }, - "recurringAmount": { + "type": { "type": "string" }, - "recurringDepositDay": { + "units": { "type": "string" + } + } + }, + "EquitiesJSONAccountSummary": { + "type": "object", + "properties": { + "investment": { + "$ref": "#/components/schemas/EquitiesJSONAccountSummaryHoldings" }, - "tenureDays": { + "currentValue": { "type": "string" }, - "tenureMonths": { + "investmentValue": { "type": "string" + } + } + }, + "EquitiesJSONAccountSummaryHoldings": { + "type": "object", + "properties": { + "holdings": { + "$ref": "#/components/schemas/EquitiesJSONAccountSummaryHoldingsHolding" }, - "tenureYears": { + "type": { "type": "string" } } }, - "TermDepositJSONAccountProfile": { + "EquitiesJSONAccountSummaryHoldingsHolding": { + "type": "object", + "properties": { + "holding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EquitiesJSONAccountSummaryHoldingsHolding" + } + } + } + }, + "EquitiesJSONAccountProfile": { "type": "object", "properties": { "holders": { - "$ref": "#/components/schemas/TermDepositJSONAccountProfileHolders" + "$ref": "#/components/schemas/EquitiesJSONAccountProfileHolders" } } }, - "TermDepositJSONAccountProfileHolders": { + "EquitiesJSONAccountProfileHolders": { "type": "object", "properties": { "type": { @@ -3312,12 +1911,12 @@ "holder": { "type": "array", "items": { - "$ref": "#/components/schemas/TermDepositJSONAccountProfileHoldersHolder" + "$ref": "#/components/schemas/EquitiesJSONAccountProfileHoldersHolder" } } } }, - "TermDepositJSONAccountProfileHoldersHolder": { + "EquitiesJSONAccountProfileHoldersHolder": { "type": "object", "properties": { "address": { @@ -3346,18 +1945,33 @@ }, "pan": { "type": "string" + }, + "rank": { + "type": "string" + }, + "dematId": { + "type": "string" + }, + "boId": { + "type": "string" + }, + "dpId": { + "type": "string" + }, + "brokerName": { + "type": "string" } } }, - "DepositJSON": { + "InsurancePoliciesJSON": { "type": "object", "properties": { "account": { - "$ref": "#/components/schemas/DepositJSONAccount" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccount" } } }, - "DepositJSONAccount": { + "InsurancePoliciesJSONAccount": { "type": "object", "properties": { "linkedAccRef": { @@ -3373,17 +1987,17 @@ "type": "string" }, "profile": { - "$ref": "#/components/schemas/DepositJSONAccountProfile" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfile" }, "summary": { - "$ref": "#/components/schemas/DepositJSONAccountSummary" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummary" }, "transactions": { - "$ref": "#/components/schemas/DepositJSONAccountTransactions" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountTransactions" } } }, - "DepositJSONAccountTransactions": { + "InsurancePoliciesJSONAccountTransactions": { "type": "object", "properties": { "startDate": { @@ -3396,1465 +2010,897 @@ "type": "array", "nullable": true, "items": { - "$ref": "#/components/schemas/DepositJSONAccountTransactionsTransaction" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountTransactionsTransaction" } } } }, - "DepositJSONAccountTransactionsTransaction": { + "InsurancePoliciesJSONAccountTransactionsTransaction": { "type": "object", "properties": { "amount": { "type": "string" }, - "currentBalance": { - "type": "string" - }, - "mode": { - "type": "string" - }, "narration": { "type": "string" }, - "reference": { - "type": "string" - }, - "transactionTimestamp": { - "type": "string" - }, "txnId": { "type": "string" }, "type": { "type": "string" - }, - "valueDate": { - "type": "string" - } - } - }, - "DepositJSONAccountSummary": { - "type": "object", - "properties": { - "balanceDateTime": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "currentBalance": { - "type": "string" - }, - "currentODLimit": { - "type": "string" - }, - "drawingLimit": { - "type": "string" - }, - "exchgeRate": { - "type": "string" - }, - "facility": { - "type": "string" - }, - "ifscCode": { - "type": "string" - }, - "micrCode": { - "type": "string" - }, - "openingDate": { - "type": "string" - }, - "pending": { - "$ref": "#/components/schemas/DepositJSONAccountSummaryPending" - }, - "status": { - "type": "string" - }, - "type": { - "type": "string" - } - } - }, - "DepositJSONAccountSummaryPending": { - "type": "object", - "properties": { - "amount": { - "type": "string" - }, - "transactionType": { - "type": "string" - } - } - }, - "DepositJSONAccountProfile": { - "type": "object", - "properties": { - "holders": { - "$ref": "#/components/schemas/DepositJSONAccountProfileHolders" - } - } - }, - "DepositJSONAccountProfileHolders": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "holder": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DepositJSONAccountProfileHoldersHolder" - } + }, + "txnDate": { + "type": "string" } } }, - "DepositJSONAccountProfileHoldersHolder": { + "InsurancePoliciesJSONAccountSummary": { "type": "object", "properties": { - "address": { - "type": "string" + "contractClauses": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryContractClauses" }, - "ckycCompliance": { - "type": "string" + "covers": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryCover" }, - "dob": { + "moneyBacks": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountMoneyBack" + }, + "coverAmount": { "type": "string" }, - "email": { + "coverType": { "type": "string" }, - "landline": { + "eiaNumber": { "type": "string" }, - "mobile": { + "maturityBenefit": { "type": "string" }, - "name": { + "maturityDate": { "type": "string" }, - "nominee": { + "policyName": { "type": "string" }, - "pan": { + "policyNumber": { "type": "string" - } - } - }, - "ConsentsRequestConsentDetailFIDataRange": { - "type": "object", - "properties": { - "to": { - "type": "string", - "format": "date-time", - "description": "Selects the ending date-time from where the financial information is to be end. It is a mandatory field only if consentTypes includes ENUM TRANSACTIONS in consent parameters." }, - "from": { - "type": "string", - "format": "date-time", - "description": "Selects the starting date-time from where the financial information is to be start. It is a mandatory field only if consentTypes includes ENUM TRANSACTIONS in consent parameters." - } - }, - "required": [ - "from", - "to" - ] - }, - "ErrorResponse": { - "type": "object", - "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" + "policyStartDate": { + "type": "string" }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." + "policyType": { + "type": "string" }, - "errorCode": { - "type": "string", - "description": "Error code indicating the problem with the request" + "premiumAmount": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "premiumFrequency": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." - } - }, - "required": [ - "errorCode", - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true - }, - "CreateFIDataFetchRequestV2": { - "type": "object", - "properties": { - "format": { - "type": "string", - "enum": [ - "xml", - "json" - ], - "description": "Format of decrypted data" + "premiumPaymentMonths": { + "type": "string" }, - "dataRange": { - "description": "Time range for which the data is being requested (should be inclusive of the consent's FIDataRange)", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" - } - ] + "premiumPaymentYears": { + "type": "string" }, - "consentId": { - "type": "string", - "format": "uuid", - "description": "The request identifier to fetch the status and data." - } - }, - "required": [ - "consentId", - "dataRange", - "format" - ] - }, - "MultiConsentResponse": { - "type": "object", - "properties": { - "consentCollectionId": { + "sumAssured": { "type": "string" }, - "url": { - "type": "string", - "description": "Webview url" + "tenureMonths": { + "type": "string" }, - "txnid": { + "tenureYears": { "type": "string" } - }, - "required": [ - "consentCollectionId", - "txnid", - "url" - ] + } }, - "MultiConsentRequest": { + "InsurancePoliciesJSONAccountMoneyBack": { "type": "object", "properties": { - "mandatoryConsents": { + "MoneyBack": { "type": "array", - "x-minimum": 1, - "x-maximum": 2, "items": { - "type": "string" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountMoneyBack" } - }, - "optionalConsents": { + } + } + }, + "InsurancePoliciesJSONAccountSummaryCover": { + "type": "object", + "properties": { + "cover": { "type": "array", - "x-maximum": 1, "items": { - "type": "string" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryCover" } } - }, - "required": [ - "mandatoryConsents" - ] + } }, - "RevokeConsentResponse": { + "InsurancePoliciesJSONAccountSummaryContractClauses": { "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "PENDING", - "ACTIVE", - "PAUSED", - "REVOKED", - "EXPIRED", - "REJECTED" - ], - "description": "Surrogate status for this consent" + "contractClause": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountSummaryContractClause" + } } - }, - "required": [ - "status" - ] + } }, - "ConsentResponseV2": { + "InsurancePoliciesJSONAccountSummaryContractClause": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "The request identifier to fetch the status and data." - }, - "url": { - "type": "string", - "description": "The URL link to the consent manager app for user to complete the flow." - }, - "status": { - "type": "string", - "enum": [ - "PENDING", - "FAILED", - "ACTIVE", - "PAUSED", - "REVOKED", - "EXPIRED", - "REJECTED" - ], - "description": "Surrogate status for this consent" + "amount": { + "type": "string" }, - "detail": { - "description": "The identifier of the Customer.", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentResponseConsentDetailV2" - } - ] + "conditions": { + "type": "string" }, - "redirectUrl": { - "type": "string", - "description": "URL to redirect to after completion of consent journey" + "description": { + "type": "string" }, - "context": { - "type": "array", - "items": { - "description": "Specify extra data in key-value pair that might be required for custom arguments or filteration", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestContext" - } - ] - } + "exlcusions": { + "type": "string" }, - "PAN": { - "type": "string", - "pattern": "^$|[A-Z]{5}[0-9]{4}[A-Z]{1}" + "subLimit": { + "type": "string" }, - "usage": { - "nullable": true, - "description": "Usage object for this consent. Defines how many times and when this consent has been used for data fetch", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentResponseConsentUsage1" - } - ] + "title": { + "type": "string" + } + } + }, + "InsurancePoliciesJSONAccountProfile": { + "type": "object", + "properties": { + "holders": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfileHolders" }, - "accountsLinked": { + "riders": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountRiders" + } + } + }, + "InsurancePoliciesJSONAccountRiders": { + "type": "object", + "properties": { + "rider": { "type": "array", - "description": "List of accounts which the consent would fetch FI from. For a consent between FIU & AA, this list could have accounts from multiple FIP. For a consent between FIP & AA, only accounts from particular FIP must be present in this section.", "items": { - "$ref": "#/components/schemas/ConsentResponseConsentDetailAccountsItem" + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfileRidersRider" } } - }, - "required": [ - "accountsLinked", - "id", - "status", - "url" - ] + } }, - "ConsentResponseConsentDetailAccountsItem": { + "InsurancePoliciesJSONAccountProfileRidersRider": { "type": "object", "properties": { - "maskedAccNumber": { - "type": "string", - "description": "Masked account number" + "policyEndDate": { + "type": "string" }, - "linkRefNumber": { - "type": "string", - "description": "FIP's linkRefNumber as shared by the FIP after linking" + "policyStartDate": { + "type": "string" }, - "fiType": { - "type": "string", - "description": "Type of Financial Information" + "premiumAmount": { + "type": "string" }, - "accType": { - "type": "string", - "description": "Type of Account" + "riderType": { + "type": "string" }, - "fipId": { - "type": "string", - "description": "FIP ID" + "sumAssured": { + "type": "string" + }, + "tenureMonths": { + "type": "string" + }, + "tenureYears": { + "type": "string" } } }, - "ConsentResponseConsentUsage1": { + "InsurancePoliciesJSONAccountProfileHolders": { "type": "object", "properties": { - "count": { - "type": "number", - "description": "Count of the number of times data has been fetched for this consent" + "type": { + "type": "string" }, - "lastUsed": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Timestamp of last data fetch for this consent" + "holder": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InsurancePoliciesJSONAccountProfileHoldersHolder" + } } - }, - "required": [ - "count", - "lastUsed" - ] + } }, - "ConsentsRequestContext": { + "InsurancePoliciesJSONAccountProfileHoldersHolder": { "type": "object", "properties": { - "value": { - "type": "string", - "description": "Value to key data" + "address": { + "type": "string" }, - "key": { - "type": "string", - "enum": [ - "accounttype", - "fipId", - "consentReviewAt", - "purposeDescription", - "purposeCode", - "alternateNumber", - "accountSelectionMode", - "transactionType", - "excludeFipIds" - ], - "description": "The key of data" + "ckycCompliance": { + "type": "string" + }, + "dob": { + "type": "string" + }, + "email": { + "type": "string" + }, + "landline": { + "type": "string" + }, + "mobile": { + "type": "string" + }, + "name": { + "type": "string" + }, + "nominee": { + "type": "string" + }, + "pan": { + "type": "string" + }, + "rank": { + "type": "string" } - }, - "required": [ - "key", - "value" - ] + } }, - "ConsentResponseConsentDetailV2": { + "RecurringDepositJSON": { "type": "object", "properties": { - "vua": { + "account": { + "$ref": "#/components/schemas/RecurringDepositJSONAccount" + } + } + }, + "RecurringDepositJSONAccount": { + "type": "object", + "properties": { + "linkedAccRef": { "type": "string" }, - "fetchType": { - "type": "string", - "enum": [ - "ONETIME", - "PERIODIC" - ], - "description": "FI Fetch type. Could be ONETIME or PERIODIC" - }, - "consentMode": { - "type": "string", - "enum": [ - "VIEW", - "STORE", - "QUERY", - "STREAM" - ], - "description": "Consent Mode as defined in the AA Technical Specification" - }, - "purpose": { - "description": "Purpose of the consent defined in the AA Technical Specification", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentResponseConsentDetailPurpose" - } - ] + "maskedAccNumber": { + "type": "string" }, - "frequency": { - "description": "Defines frequency of FI data fetch within the defined time unit. E.g.HOURLY,DAILY,MONTHLY,YEARLY.The maximum frequency value that can be defined is 1 request per HOUR. Similaraly it will be 24 requests per DAY and so on. Frequency can not be set below 1 request per hour.", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFrequency" - } - ] + "type": { + "type": "string" }, - "dataRange": { - "description": "Data Range (Datetime) for the Financial Information Requested", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange1" - } - ] + "version": { + "type": "string" }, - "dataFilter": { - "type": "array", - "description": "rules that will be utilized by FIP to filter the data", - "items": { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataFilterItem" - } + "profile": { + "$ref": "#/components/schemas/RecurringDepositJSONAccountProfile" }, - "fiTypes": { - "type": "array", - "x-minimum": 1, - "items": { - "type": "string", - "enum": [ - "DEPOSIT", - "TERM_DEPOSIT", - "RECURRING_DEPOSIT", - "SIP", - "CP", - "GOVT_SECURITIES", - "EQUITIES", - "BONDS", - "DEBENTURES", - "MUTUAL_FUNDS", - "ETF", - "IDR", - "CIS", - "AIF", - "INSURANCE_POLICIES", - "NPS", - "INVIT", - "REIT", - "GSTR1_3B", - "OTHER" - ], - "description": "List of financial information types." - } + "summary": { + "$ref": "#/components/schemas/RecurringDepositJSONAccountSummary" }, - "dataLife": { - "description": "Datalife defines for how long can the FIU/AA Application store the data", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataLife" - } - ] + "transactions": { + "$ref": "#/components/schemas/RecurringDepositJSONAccountTransactions" + } + } + }, + "RecurringDepositJSONAccountTransactions": { + "type": "object", + "properties": { + "startDate": { + "type": "string" }, - "consentExpiry": { - "type": "string", - "format": "date-time", - "description": "Expiry date-time for the consent" + "endDate": { + "type": "string" }, - "consentTypes": { + "transaction": { "type": "array", - "x-minimum": 1, + "nullable": true, "items": { - "type": "string", - "enum": [ - "PROFILE", - "SUMMARY", - "TRANSACTIONS" - ] + "$ref": "#/components/schemas/RecurringDepositJSONAccountTransactionsTransaction" } - }, - "consentStart": { - "type": "string", - "format": "date-time", - "description": "Start date-time of the consent. This field would allow for Post-Dated consent." } - }, - "required": [ - "consentExpiry", - "consentStart" - ] + } }, - "ConsentsRequestConsentDetailDataLife": { + "RecurringDepositJSONAccountTransactionsTransaction": { "type": "object", "properties": { - "unit": { - "type": "string", - "enum": [ - "MONTH", - "YEAR", - "DAY", - "INF" - ], - "description": "A unit of how long consumer can store the data" + "amount": { + "type": "string" }, - "value": { - "type": "integer", - "description": "Define the value of unit of how long can consumer store the data" + "currentBalance": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "transactionTimestamp": { + "type": "string" + }, + "txnId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "valueDate": { + "type": "string" } - }, - "required": [ - "unit", - "value" - ] + } }, - "ConsentsRequestConsentDetailDataFilterItem": { + "RecurringDepositJSONAccountSummary": { "type": "object", "properties": { - "operator": { - "type": "string", - "enum": [ - "=", - "!=", - ">", - "<", - ">=", - "<=" - ], - "description": "Operator to filter data by." + "accountType": { + "type": "string" }, - "value": { - "type": "string", - "description": "Value to filter data" + "branch": { + "type": "string" }, - "type": { - "type": "string", - "enum": [ - "TRANSACTIONTYPE", - "TRANSACTIONAMOUNT" - ], - "description": "The condition to filter the data on." + "compoundingFrequency": { + "type": "string" + }, + "currentValue": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ifsc": { + "type": "string" + }, + "interestComputation": { + "type": "string" + }, + "interestOnMaturity": { + "type": "string" + }, + "interestPayout": { + "type": "string" + }, + "interestPeriodicPayoutAmount": { + "type": "string" + }, + "interestRate": { + "type": "string" + }, + "maturityAmount": { + "type": "string" + }, + "maturityDate": { + "type": "string" + }, + "openingDate": { + "type": "string" + }, + "principalAmount": { + "type": "string" + }, + "recurringAmount": { + "type": "string" + }, + "recurringDepositDay": { + "type": "string" + }, + "tenureDays": { + "type": "string" + }, + "tenureMonths": { + "type": "string" + }, + "tenureYears": { + "type": "string" } - }, - "required": [ - "operator", - "type", - "value" - ] + } }, - "ConsentsRequestConsentDetailFIDataRange1": { + "RecurringDepositJSONAccountProfile": { "type": "object", "properties": { - "to": { - "type": "string", - "format": "date-time", - "description": "End date for financial information" - }, - "from": { - "type": "string", - "format": "date-time", - "description": "Start date for financial information" + "holders": { + "$ref": "#/components/schemas/RecurringDepositJSONAccountProfileHolders" } - }, - "required": [ - "from", - "to" - ] + } }, - "ConsentsRequestConsentDetailFrequency": { + "RecurringDepositJSONAccountProfileHolders": { "type": "object", "properties": { - "unit": { - "type": "string", - "enum": [ - "HOUR", - "DAY", - "MONTH", - "YEAR", - "INF" - ], - "description": "Defines the time unit of the frequency to access the financial information." + "type": { + "type": "string" }, - "value": { - "type": "integer", - "description": "Define the number of times FI data can be fetched within the defined time unit." + "holder": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecurringDepositJSONAccountProfileHoldersHolder" + } } - }, - "required": [ - "unit", - "value" - ] + } }, - "ConsentResponseConsentDetailPurpose": { + "RecurringDepositJSONAccountProfileHoldersHolder": { "type": "object", "properties": { - "code": { - "type": "string", - "enum": [ - "101", - "102", - "103", - "104", - "105", - "106" - ], - "description": "Purpose Code as defined in the AA Technical Specification " + "address": { + "type": "string" }, - "text": { - "type": "string", - "description": "Textual Description" + "ckycCompliance": { + "type": "string" }, - "category": { - "$ref": "#/components/schemas/PurposeCategory1" + "dob": { + "type": "string" }, - "refUri": { - "type": "string", - "description": "URL where the purpose is further defined" + "email": { + "type": "string" + }, + "landline": { + "type": "string" + }, + "mobile": { + "type": "string" + }, + "name": { + "type": "string" + }, + "nominee": { + "type": "string" + }, + "pan": { + "type": "string" } - }, - "required": [ - "code" - ] + } }, - "PurposeCategory1": { + "TermDepositJSON": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Category name of the Purpose code" + "account": { + "$ref": "#/components/schemas/TermDepositJSONAccount" } } }, - "CreateConsentRequestV2": { + "TermDepositJSONAccount": { "type": "object", "properties": { - "consentDateRange": { - "$ref": "#/components/schemas/ConsentDateRange" - }, - "vua": { + "linkedAccRef": { "type": "string" }, - "fetchType": { - "type": "string", - "enum": [ - "ONETIME", - "PERIODIC" - ] + "maskedAccNumber": { + "type": "string" }, - "purpose": { - "description": "Purpose of the consent defined in the AA Technical Specification", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentRequestPurpose" - } - ] + "type": { + "type": "string" }, - "consentMode": { - "type": "string", - "enum": [ - "VIEW", - "STORE", - "QUERY", - "STREAM" - ], - "description": "Consent Mode as defined in the AA Technical Specification" + "version": { + "type": "string" }, - "frequency": { - "description": "Defines frequency of FI data fetch within the defined time unit. E.g.HOURLY,DAILY,MONTHLY,YEARLY.The maximum frequency value that can be defined is 1 request per HOUR. Similaraly it will be 24 requests per DAY and so on. Frequency can not be set below 1 request per hour.", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFrequency" - } - ] + "profile": { + "$ref": "#/components/schemas/TermDepositJSONAccountProfile" }, - "consentDuration": { - "description": "How long consumer is allowed to store data", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentDurartion" - } - ] + "summary": { + "$ref": "#/components/schemas/TermDepositJSONAccountSummary" }, - "dataRange": { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange1" + "transactions": { + "$ref": "#/components/schemas/TermDepositJSONAccountTransactions" + } + } + }, + "TermDepositJSONAccountTransactions": { + "type": "object", + "properties": { + "startDate": { + "type": "string" }, - "PAN": { - "type": "string", - "pattern": "^$|[A-Z]{5}[0-9]{4}[A-Z]{1}" + "endDate": { + "type": "string" }, - "context": { + "transaction": { "type": "array", + "nullable": true, "items": { - "description": "Specify extra data in key-value pair that might be required for custom arguments or filteration", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestContext" - } - ] + "$ref": "#/components/schemas/TermDepositJSONAccountTransactionsTransaction" } + } + } + }, + "TermDepositJSONAccountTransactionsTransaction": { + "type": "object", + "properties": { + "amount": { + "type": "string" }, - "redirectUrl": { + "currentBalance": { "type": "string" }, - "dataFilter": { - "type": "array", - "description": "rules that will be utilized by FIP to filter the data", - "items": { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataFilterItem" - } + "mode": { + "type": "string" }, - "fiTypes": { - "type": "array", - "x-minimum": 1, - "items": { - "type": "string", - "enum": [ - "DEPOSIT", - "TERM_DEPOSIT", - "RECURRING_DEPOSIT", - "SIP", - "CP", - "GOVT_SECURITIES", - "EQUITIES", - "BONDS", - "DEBENTURES", - "MUTUAL_FUNDS", - "ETF", - "IDR", - "CIS", - "AIF", - "INSURANCE_POLICIES", - "NPS", - "INVIT", - "REIT", - "GSTR1_3B", - "OTHER" - ], - "description": "List of financial information types." - } + "narration": { + "type": "string" }, - "dataLife": { - "description": "How long consumer is allowed to store data", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataLife" - } - ] + "reference": { + "type": "string" }, - "consentTypes": { - "type": "array", - "x-minimum": 1, - "items": { - "type": "string", - "enum": [ - "PROFILE", - "SUMMARY", - "TRANSACTIONS" - ] - } - } - }, - "required": [ - "dataRange", - "vua" - ] - }, - "ConsentDurartion": { - "type": "object", - "properties": { - "unit": { - "type": "string", - "enum": [ - "MONTH", - "YEAR", - "DAY" - ], - "description": "A unit of how long consumer can store the data" + "transactionTimestamp": { + "type": "string" }, - "value": { - "type": "integer", - "description": "Define the value of unit of how long can consumer store the data" + "txnId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "valueDate": { + "type": "string" } - }, - "required": [ - "unit", - "value" - ] + } }, - "ConsentRequestPurpose": { + "TermDepositJSONAccountSummary": { "type": "object", "properties": { - "code": { - "type": "string", - "enum": [ - "101", - "102", - "103", - "104", - "105", - "106" - ], - "description": "Purpose Code as defined in the AA Technical Specification " + "accountType": { + "type": "string" }, - "text": { - "type": "string", - "description": "Textual Description" + "branch": { + "type": "string" }, - "category": { - "$ref": "#/components/schemas/PurposeCategory1" + "compoundingFrequency": { + "type": "string" }, - "refUri": { - "type": "string", - "description": "URL where the purpose is further defined" - } - }, - "required": [ - "category", - "code", - "refUri", - "text" - ] - }, - "ConsentDateRange": { - "type": "object", - "properties": { - "startDate": { - "type": "string", - "format": "date-time", - "description": "Expiry date-time for the consent" + "currentValue": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ifsc": { + "type": "string" + }, + "interestComputation": { + "type": "string" + }, + "interestOnMaturity": { + "type": "string" + }, + "interestPayout": { + "type": "string" + }, + "interestPeriodicPayoutAmount": { + "type": "string" + }, + "interestRate": { + "type": "string" + }, + "maturityAmount": { + "type": "string" + }, + "maturityDate": { + "type": "string" }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "Expiry date-time for the consent" - } - }, - "required": [ - "endDate", - "startDate" - ] - }, - "FIStatusNotification": { - "type": "object", - "properties": { - "txnid": { - "type": "string", - "format": "uuid", - "description": "The unique transaction identifier used for providing an end to end traceability." + "openingDate": { + "type": "string" }, - "FIStatusNotification": { - "description": "Selects a type of Data-flow events , Consent-flow events, and Account discovery flow events", - "allOf": [ - { - "$ref": "#/components/schemas/FIStatusNotificationFIStatusNotification" - } - ] + "principalAmount": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp of the message which will be updated at each leg" + "recurringAmount": { + "type": "string" }, - "Notifier": { - "description": "Information about the notifier", - "allOf": [ - { - "$ref": "#/components/schemas/FIStatusNotificationNotifier" - } - ] + "recurringDepositDay": { + "type": "string" }, - "ver": { - "type": "string", - "minLength": 1, - "description": "The version of the API" + "tenureDays": { + "type": "string" + }, + "tenureMonths": { + "type": "string" + }, + "tenureYears": { + "type": "string" } - }, - "required": [ - "FIStatusNotification", - "Notifier", - "timestamp", - "txnid", - "ver" - ] + } }, - "FIStatusNotificationNotifier": { + "TermDepositJSONAccountProfile": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "Value of the destination address for locating the resource to maintain the logs" - }, - "type": { - "type": "string", - "description": "" + "holders": { + "$ref": "#/components/schemas/TermDepositJSONAccountProfileHolders" } - }, - "required": [ - "id", - "type" - ] + } }, - "FIStatusNotificationFIStatusNotification": { + "TermDepositJSONAccountProfileHolders": { "type": "object", "properties": { - "sessionStatus": { - "type": "string", - "enum": [ - "ACTIVE", - "COMPLETED", - "EXPIRED", - "FAILED" - ] + "type": { + "type": "string" }, - "FIStatusResponse": { + "holder": { "type": "array", - "minItems": 1, "items": { - "$ref": "#/components/schemas/FIStatusNotificationFIStatusNotificationFIStatusResponseItem" + "$ref": "#/components/schemas/TermDepositJSONAccountProfileHoldersHolder" } - }, - "sessionId": { - "type": "string", - "format": "uuid" } - }, - "required": [ - "FIStatusResponse", - "sessionId", - "sessionStatus" - ] + } }, - "FIStatusNotificationFIStatusNotificationFIStatusResponseItem": { + "TermDepositJSONAccountProfileHoldersHolder": { "type": "object", "properties": { - "Accounts": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/FIStatusNotificationFIStatusNotificationFIStatusResponseItemAccountsItem" - } + "address": { + "type": "string" }, - "fipID": { - "type": "string", - "minLength": 1 - } - }, - "required": [ - "Accounts", - "fipID" - ] - }, - "FIStatusNotificationFIStatusNotificationFIStatusResponseItemAccountsItem": { - "type": "object", - "properties": { - "linkRefNumber": { - "type": "string", - "minLength": 1 + "ckycCompliance": { + "type": "string" }, - "description": { - "type": "string", - "minLength": 1 + "dob": { + "type": "string" }, - "FIStatus": { - "type": "string", - "enum": [ - "READY", - "DENIED", - "PENDING", - "DELIVERED", - "TIMEOUT" - ] - } - }, - "required": [ - "FIStatus", - "description", - "linkRefNumber" - ] - }, - "NotificationResponse": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "description": "Creation timestamp of the message which will be updated at each call" + "email": { + "type": "string" }, - "txnid": { - "type": "string", - "description": "An unique transaction identifier used for providing an end to end traceability." + "landline": { + "type": "string" }, - "response": { - "type": "string", - "description": "response description" + "mobile": { + "type": "string" }, - "ver": { - "type": "string", - "description": "The version of the API" + "name": { + "type": "string" + }, + "nominee": { + "type": "string" + }, + "pan": { + "type": "string" } - }, - "required": [ - "response", - "timestamp", - "txnid", - "ver" - ] + } }, - "UnauthorizedAccess": { + "DepositJSON": { "type": "object", "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" - }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." - }, - "errorCode": { - "type": "string", - "enum": [ - "Unauthorized" - ] - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" - }, - "ver": { - "type": "string", - "description": "API version." + "account": { + "$ref": "#/components/schemas/DepositJSONAccount" } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true + } }, - "NotFound": { + "DepositJSONAccount": { "type": "object", "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" + "linkedAccRef": { + "type": "string" }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." + "maskedAccNumber": { + "type": "string" }, - "errorCode": { - "type": "string", - "enum": [ - "NoSuchVersion" - ], - "description": "Indicates that the version ID specified in the request does not match an existing version" + "type": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "version": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." + "profile": { + "$ref": "#/components/schemas/DepositJSONAccountProfile" + }, + "summary": { + "$ref": "#/components/schemas/DepositJSONAccountSummary" + }, + "transactions": { + "$ref": "#/components/schemas/DepositJSONAccountTransactions" } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true + } }, - "Conflict": { + "DepositJSONAccountTransactions": { "type": "object", "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" - }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." - }, - "errorCode": { - "type": "string", - "enum": [ - "IdempotencyError" - ], - "description": "IdempotencyError When UUID/Id is not unique" + "startDate": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "endDate": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." + "transaction": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/DepositJSONAccountTransactionsTransaction" + } } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true + } }, - "PreconditionFailed": { + "DepositJSONAccountTransactionsTransaction": { "type": "object", "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" + "amount": { + "type": "string" }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." + "currentBalance": { + "type": "string" }, - "errorCode": { - "type": "string", - "enum": [ - "PreconditionFailed" - ] + "mode": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "narration": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." - } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true - }, - "InternalServerError": { - "type": "object", - "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" + "reference": { + "type": "string" }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." + "transactionTimestamp": { + "type": "string" }, - "errorCode": { - "type": "string", - "enum": [ - "InternalError" - ] + "txnId": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "type": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." + "valueDate": { + "type": "string" } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true + } }, - "ServiceUnavailable": { + "DepositJSONAccountSummary": { "type": "object", "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" + "balanceDateTime": { + "type": "string" }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." + "branch": { + "type": "string" }, - "errorCode": { - "type": "string", - "enum": [ - "ServiceUnavailable" - ] + "currency": { + "type": "string" }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "currentBalance": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." + "currentODLimit": { + "type": "string" + }, + "drawingLimit": { + "type": "string" + }, + "exchgeRate": { + "type": "string" + }, + "facility": { + "type": "string" + }, + "ifscCode": { + "type": "string" + }, + "micrCode": { + "type": "string" + }, + "openingDate": { + "type": "string" + }, + "pending": { + "$ref": "#/components/schemas/DepositJSONAccountSummaryPending" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true + } }, - "BadRequestConsentFetch": { + "DepositJSONAccountSummaryPending": { "type": "object", "properties": { - "txnid": { - "type": "string", - "description": "Trnsaction id of the request. Must be same value as sent in the request" - }, - "errorMsg": { - "type": "string", - "description": "Error message with additional details. Ensure no sensitive information is included in the error message." - }, - "errorCode": { - "type": "string", - "enum": [ - "InvalidRequest", - "InvalidURI", - "InvalidSecurity", - "SignatureDoesNotMatch", - "InvalidConsentId" - ] - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Response timestamp" + "amount": { + "type": "string" }, - "ver": { - "type": "string", - "description": "API version." + "transactionType": { + "type": "string" } - }, - "required": [ - "errorMsg", - "timestamp", - "txnid", - "ver" - ], - "additionalProperties": true + } }, - "PassDownSerializedBody": { + "DepositJSONAccountProfile": { "type": "object", "properties": { - "serialized_body": { - "type": "string", - "description": "Serialized data from body" + "holders": { + "$ref": "#/components/schemas/DepositJSONAccountProfileHolders" } } }, - "ConsentStatusNotification": { + "DepositJSONAccountProfileHolders": { "type": "object", "properties": { - "txnid": { - "type": "string", - "format": "uuid", - "description": "The unique transaction identifier used for providing an end to end traceability." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp of the message which will be updated at each leg" - }, - "Notifier": { - "description": "Information about the notifier", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentStatusNotificationNotifier" - } - ] - }, - "ConsentStatusNotification": { - "description": "Selects a type of Data-flow events , Consent-flow events, and Account discovery flow events", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentStatusNotificationConsentStatusNotification" - } - ] + "type": { + "type": "string" }, - "ver": { - "type": "string", - "minLength": 1, - "description": "The version of the API" + "holder": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DepositJSONAccountProfileHoldersHolder" + } } - }, - "required": [ - "ConsentStatusNotification", - "Notifier", - "timestamp", - "txnid", - "ver" - ] + } }, - "ConsentStatusNotificationConsentStatusNotification": { + "DepositJSONAccountProfileHoldersHolder": { "type": "object", "properties": { - "consentHandle": { - "type": "string", - "format": "uuid" + "address": { + "type": "string" }, - "consentId": { - "type": "string", - "format": "uuid", - "nullable": true + "ckycCompliance": { + "type": "string" }, - "consentStatus": { - "type": "string", - "enum": [ - "ACTIVE", - "PENDING", - "REVOKED", - "PAUSED", - "EXPIRED", - "REJECTED" - ] + "dob": { + "type": "string" + }, + "email": { + "type": "string" + }, + "landline": { + "type": "string" + }, + "mobile": { + "type": "string" + }, + "name": { + "type": "string" + }, + "nominee": { + "type": "string" + }, + "pan": { + "type": "string" } - }, - "required": [ - "consentId", - "consentStatus" - ] + } }, - "ConsentStatusNotificationNotifier": { + "ErrorResponse": { "type": "object", "properties": { - "id": { + "errorMsg": { "type": "string", - "description": "Value of the destination address for locating the resource to maintain the logs" + "description": "Error message with additional details. Ensure no sensitive information is included in the error message." }, - "type": { + "ver": { + "type": "string", + "description": "API version." + }, + "errorCode": { "type": "string", - "description": "" + "description": "Error code indicating the problem with the request" + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Response timestamp" + }, + "txnid": { + "type": "string", + "description": "Trnsaction id of the request. Must be same value as sent in the request" } }, "required": [ - "id", - "type" - ] + "errorCode", + "errorMsg", + "timestamp", + "txnid", + "ver" + ], + "additionalProperties": true }, - "FIDataFetchResponse": { + "CreateFIDataFetchRequestV2": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Request identifier to fetch the status and data." - }, - "Payload": { - "type": "array", - "nullable": true, - "description": "Time range for which the data is being requested", - "items": { - "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItem" - } - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "PENDING", - "COMPLETED", - "EXPIRED", - "FAILED", - "PARTIAL" - ], - "description": "Status for this data fetch session" + "dataRange": { + "description": "Time range for which the data is being requested (should be inclusive of the consent's FIDataRange)", + "allOf": [ + { + "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" + } + ] }, "consentId": { "type": "string", "format": "uuid", - "description": "Consent identifier for this data fetch request." + "description": "The request identifier to fetch the status and data." }, "format": { "type": "string", @@ -4863,154 +2909,78 @@ "json" ], "description": "Format of decrypted data" - }, - "DataRange": { - "description": "Time range for which the data is being requested", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" - } - ] } }, "required": [ - "DataRange", - "Payload", "consentId", - "format", - "id", - "status" + "dataRange", + "format" ] }, - "FIFetchDecrpytedResponseFIItem": { + "MultiConsentResponse": { "type": "object", "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItemDataItem" - } + "consentCollectionId": { + "type": "string" }, - "fipID": { + "url": { + "type": "string", + "description": "Webview url" + }, + "txnid": { "type": "string" } }, "required": [ - "data", - "fipID" + "consentCollectionId", + "txnid", + "url" ] }, - "FIFetchDecrpytedResponseFIItemDataItem": { + "MultiConsentRequest": { "type": "object", "properties": { - "maskedAccNumber": { - "type": "string" - }, - "linkRefNumber": { - "type": "string" + "mandatoryConsents": { + "type": "array", + "x-minimum": 1, + "x-maximum": 2, + "items": { + "type": "string" + } }, - "decryptedFI": { - "description": "Contains the decrypted financial information", - "allOf": [ - { - "$ref": "#/components/schemas/FIFetchDecrpytedResponseFIItemDataItemDecryptedFI" - } - ] + "optionalConsents": { + "type": "array", + "x-maximum": 1, + "items": { + "type": "string" + } } }, "required": [ - "decryptedFI", - "linkRefNumber", - "maskedAccNumber" + "mandatoryConsents" ] }, - "FIFetchDecrpytedResponseFIItemDataItemDecryptedFI": { - "type": "object", - "properties": {}, - "oneOf": [ - { - "$ref": "#/components/schemas/DepositJSON" - }, - { - "$ref": "#/components/schemas/TermDepositJSON" - }, - { - "$ref": "#/components/schemas/RecurringDepositJSON" - }, - { - "$ref": "#/components/schemas/InsurancePoliciesJSON" - }, - { - "$ref": "#/components/schemas/InsurancePoliciesJSON" - }, - { - "$ref": "#/components/schemas/EquitiesJSON" - }, - { - "$ref": "#/components/schemas/MutualFundsJSON" - }, - { - "$ref": "#/components/schemas/MutualFundsJSON" - }, - { - "$ref": "#/components/schemas/GST" - }, - { - "$ref": "#/components/schemas/ETFJSON" - }, - { - "$ref": "#/components/schemas/XML" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "deposit": "#/components/schemas/DepositJSON", - "term_deposit": "#/components/schemas/TermDepositJSON", - "recurring_deposit": "#/components/schemas/RecurringDepositJSON", - "insurance_policies": "#/components/schemas/InsurancePoliciesJSON", - "insurance": "#/components/schemas/InsurancePoliciesJSON", - "equities": "#/components/schemas/EquitiesJSON", - "mutual_funds": "#/components/schemas/MutualFundsJSON", - "mutualfunds": "#/components/schemas/MutualFundsJSON", - "gstr1_3b": "#/components/schemas/GST", - "etf": "#/components/schemas/ETFJSON", - "xml": "#/components/schemas/XML" - } - } - }, - "CreateFIDataFetchRequest": { + "RevokeConsentResponse": { "type": "object", "properties": { - "format": { + "status": { "type": "string", "enum": [ - "xml", - "json" + "PENDING", + "ACTIVE", + "PAUSED", + "REVOKED", + "EXPIRED", + "REJECTED" ], - "description": "Format of decrypted data" - }, - "consentId": { - "type": "string", - "format": "uuid", - "description": "The request identifier to fetch the status and data." - }, - "DataRange": { - "description": "Time range for which the data is being requested (should be inclusive of the consent's FIDataRange)", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" - } - ] + "description": "Surrogate status for this consent" } }, "required": [ - "DataRange", - "consentId", - "format" + "status" ] }, - "ConsentResponse": { + "ConsentResponseV2": { "type": "object", "properties": { "id": { @@ -5034,11 +3004,11 @@ ], "description": "Surrogate status for this consent" }, - "Detail": { + "detail": { "description": "The identifier of the Customer.", "allOf": [ { - "$ref": "#/components/schemas/ConsentDetailsAggregated" + "$ref": "#/components/schemas/ConsentResponseConsentDetailV2" } ] }, @@ -5046,10 +3016,6 @@ "type": "string", "description": "URL to redirect to after completion of consent journey" }, - "PAN": { - "type": "string", - "pattern": "^$|[A-Z]{5}[0-9]{4}[A-Z]{1}" - }, "context": { "type": "array", "items": { @@ -5061,36 +3027,71 @@ ] } }, - "Usage": { + "PAN": { + "type": "string", + "pattern": "^$|[A-Z]{5}[0-9]{4}[A-Z]{1}" + }, + "usage": { "nullable": true, "description": "Usage object for this consent. Defines how many times and when this consent has been used for data fetch", "allOf": [ { - "$ref": "#/components/schemas/ConsentResponseConsentUsage" + "$ref": "#/components/schemas/ConsentResponseConsentUsage1" } ] + }, + "accountsLinked": { + "type": "array", + "description": "List of accounts which the consent would fetch FI from. For a consent between FIU & AA, this list could have accounts from multiple FIP. For a consent between FIP & AA, only accounts from particular FIP must be present in this section.", + "items": { + "$ref": "#/components/schemas/ConsentResponseConsentDetailAccountsItem" + } + } + }, + "required": [ + "accountsLinked", + "id", + "status", + "url" + ] + }, + "ConsentResponseConsentDetailAccountsItem": { + "type": "object", + "properties": { + "fipId": { + "type": "string", + "description": "FIP ID" + }, + "accType": { + "type": "string", + "description": "Type of Account" + }, + "fiType": { + "type": "string", + "description": "Type of Financial Information" + }, + "maskedAccNumber": { + "type": "string", + "description": "Masked account number" + }, + "linkRefNumber": { + "type": "string", + "description": "FIP's linkRefNumber as shared by the FIP after linking" } - }, - "required": [ - "Detail", - "id", - "redirectUrl", - "status", - "url" - ] + } }, - "ConsentResponseConsentUsage": { + "ConsentResponseConsentUsage1": { "type": "object", "properties": { - "count": { - "type": "number", - "description": "Count of the number of times data has been fetched for this consent" - }, "lastUsed": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp of last data fetch for this consent" + }, + "count": { + "type": "number", + "description": "Count of the number of times data has been fetched for this consent" } }, "required": [ @@ -5098,7 +3099,35 @@ "lastUsed" ] }, - "ConsentDetailsAggregated": { + "ConsentsRequestContext": { + "type": "object", + "properties": { + "key": { + "type": "string", + "enum": [ + "accounttype", + "fipId", + "consentReviewAt", + "purposeDescription", + "purposeCode", + "alternateNumber", + "accountSelectionMode", + "transactionType", + "excludeFipIds" + ], + "description": "The key of data" + }, + "value": { + "type": "string", + "description": "Value to key data" + } + }, + "required": [ + "key", + "value" + ] + }, + "ConsentResponseConsentDetailV2": { "type": "object", "properties": { "fetchType": { @@ -5109,52 +3138,56 @@ ], "description": "FI Fetch type. Could be ONETIME or PERIODIC" }, - "consentMode": { + "consentExpiry": { "type": "string", - "enum": [ - "VIEW", - "STORE", - "QUERY", - "STREAM" - ], - "description": "Consent Mode as defined in the AA Technical Specification" + "format": "date-time", + "description": "Expiry date-time for the consent" }, - "Customer": { - "description": "Address of the end customer", - "allOf": [ - { - "$ref": "#/components/schemas/SignedConsentDetailCustomer" - } - ] + "consentStart": { + "type": "string", + "format": "date-time", + "description": "Start date-time of the consent. This field would allow for Post-Dated consent." }, - "Purpose": { - "description": "Purpose of the consent defined in the AA Technical Specification", + "frequency": { + "description": "Defines frequency of FI data fetch within the defined time unit. E.g.HOURLY,DAILY,MONTHLY,YEARLY.The maximum frequency value that can be defined is 1 request per HOUR. Similaraly it will be 24 requests per DAY and so on. Frequency can not be set below 1 request per hour.", "allOf": [ { - "$ref": "#/components/schemas/ConsentDetailPurpose" + "$ref": "#/components/schemas/ConsentsRequestConsentDetailFrequency" } ] }, - "DataProvider": { - "description": "DataProvider ID. For a consent between FIP & AA, DataProvider would be FIP whereas for a consent between FIU/AA Application & AA, DataProvider would be AA.", + "dataFilter": { + "type": "array", + "description": "rules that will be utilized by FIP to filter the data", + "items": { + "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataFilterItem" + } + }, + "purpose": { + "description": "Purpose of the consent defined in the AA Technical Specification", "allOf": [ { - "$ref": "#/components/schemas/SignedConsentDetailDataProvider" + "$ref": "#/components/schemas/ConsentResponseConsentDetailPurpose" } ] }, - "Accounts": { + "consentTypes": { "type": "array", - "description": "List of accounts which the consent would fetch FI from. For a consent between FIU & AA, this list could have accounts from multiple FIP. For a consent between FIP & AA, only accounts from particular FIP must be present in this section.", + "x-minimum": 1, "items": { - "$ref": "#/components/schemas/SignedConsentDetailAccountsItem" + "type": "string", + "enum": [ + "PROFILE", + "SUMMARY", + "TRANSACTIONS" + ] } }, - "FIDataRange": { + "dataRange": { "description": "Data Range (Datetime) for the Financial Information Requested", "allOf": [ { - "$ref": "#/components/schemas/SignedConsentDetailFIDataRange" + "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange1" } ] }, @@ -5182,172 +3215,55 @@ "NPS", "INVIT", "REIT", - "OTHER", - "GSTR1_3B" + "GSTR1_3B", + "OTHER" ], "description": "List of financial information types." } }, - "consentExpiry": { - "type": "string", - "format": "date-time", - "description": "Expiry date-time for the consent" - }, - "consentTypes": { - "type": "array", - "x-minimum": 1, - "items": { - "type": "string", - "enum": [ - "PROFILE", - "SUMMARY", - "TRANSACTIONS" - ] - } + "vua": { + "type": "string" }, - "DataLife": { + "dataLife": { "description": "Datalife defines for how long can the FIU/AA Application store the data", "allOf": [ { - "$ref": "#/components/schemas/SignedConsentDetailDataLife" - } - ] - }, - "Frequency": { - "description": "Defines frequency of FI data fetch within the defined time unit. E.g.HOURLY,DAILY,MONTHLY,YEARLY.The maximum frequency value that can be defined is 1 request per HOUR. Similaraly it will be 24 requests per DAY and so on. Frequency can not be set below 1 request per hour.", - "allOf": [ - { - "$ref": "#/components/schemas/SignedConsentDetailFrequency" - } - ] - }, - "DataFilter": { - "type": "array", - "nullable": true, - "description": "rules that will be utilized by FIP to filter the data", - "items": { - "$ref": "#/components/schemas/SignedConsentDetailDataFilterItem" - } - }, - "consentStart": { - "type": "string", - "format": "date-time", - "description": "Start date-time of the consent. This field would allow for Post-Dated consent." - }, - "DataConsumer": { - "description": "Dataconsumer ID. For a consent between FIP & AA, Dataconsumer would be AA whereas for a consent between FIU/AA Application & AA, Dataconsumer would be FIU/AA Application.", - "allOf": [ - { - "$ref": "#/components/schemas/SignedConsentDetailDataConsumer" + "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataLife" } ] - } - }, - "required": [ - "Customer", - "DataConsumer", - "DataLife", - "FIDataRange", - "Frequency", - "Purpose", - "consentExpiry", - "consentMode", - "consentStart", - "consentTypes", - "fetchType", - "fiTypes" - ] - }, - "SignedConsentDetailDataConsumer": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "DataConsumer ID" - }, - "type": { - "type": "string", - "enum": [ - "FIU", - "AA" - ], - "description": "Type of DataConsumer" - } - } - }, - "SignedConsentDetailDataFilterItem": { - "type": "object", - "properties": { - "operator": { - "type": "string", - "enum": [ - "=", - "!=", - ">", - "<", - ">=", - "<=" - ], - "description": "Operator to filter data by." - }, - "value": { - "type": "string", - "description": "Value to filter data" }, - "type": { - "type": "string", - "enum": [ - "TRANSACTIONTYPE", - "TRANSACTIONAMOUNT" - ], - "description": "The condition to filter the data on." - } - }, - "required": [ - "operator", - "type", - "value" - ] - }, - "SignedConsentDetailFrequency": { - "type": "object", - "properties": { - "unit": { + "consentMode": { "type": "string", "enum": [ - "HOUR", - "DAY", - "MONTH", - "YEAR" + "VIEW", + "STORE", + "QUERY", + "STREAM" ], - "description": "Defines the time unit of the frequency to access the financial information." - }, - "value": { - "type": "number", - "description": "Define the number of times FI data can be fetched within the defined time unit." + "description": "Consent Mode as defined in the AA Technical Specification" } }, "required": [ - "unit", - "value" + "consentExpiry", + "consentStart" ] }, - "SignedConsentDetailDataLife": { + "ConsentsRequestConsentDetailDataLife": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ - "DAY", "MONTH", "YEAR", + "DAY", "INF" ], - "description": "A unit of how long consumer can store the data." + "description": "A unit of how long consumer can store the data" }, "value": { - "type": "number", - "description": "Value for the Datalife Unit. If INF, value must be set to 0." + "type": "integer", + "description": "Define the value of unit of how long can consumer store the data" } }, "required": [ @@ -5355,7 +3271,7 @@ "value" ] }, - "SignedConsentDetailFIDataRange": { + "ConsentsRequestConsentDetailFIDataRange1": { "type": "object", "properties": { "to": { @@ -5368,55 +3284,13 @@ "format": "date-time", "description": "Start date for financial information" } - }, - "required": [ - "from", - "to" - ] - }, - "SignedConsentDetailAccountsItem": { - "type": "object", - "properties": { - "maskedAccNumber": { - "type": "string", - "description": "Masked account number" - }, - "linkRefNumber": { - "type": "string", - "description": "FIP's linkRefNumber as shared by the FIP after linking" - }, - "fiType": { - "type": "string", - "description": "Type of Financial Information" - }, - "accType": { - "type": "string", - "description": "Type of Account" - }, - "fipId": { - "type": "string", - "description": "FIP ID" - } - } - }, - "SignedConsentDetailDataProvider": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "DataProvider ID" - }, - "type": { - "type": "string", - "enum": [ - "FIP", - "AA" - ], - "description": "Type of DataConsumer" - } - } + }, + "required": [ + "from", + "to" + ] }, - "ConsentDetailPurpose": { + "ConsentResponseConsentDetailPurpose": { "type": "object", "properties": { "code": { @@ -5431,26 +3305,23 @@ ], "description": "Purpose Code as defined in the AA Technical Specification " }, - "Category": { - "$ref": "#/components/schemas/PurposeCategory" - }, "text": { "type": "string", "description": "Textual Description" }, + "category": { + "$ref": "#/components/schemas/PurposeCategory1" + }, "refUri": { "type": "string", "description": "URL where the purpose is further defined" } }, "required": [ - "Category", - "code", - "refUri", - "text" + "code" ] }, - "PurposeCategory": { + "PurposeCategory1": { "type": "object", "properties": { "type": { @@ -5459,25 +3330,85 @@ } } }, - "SignedConsentDetailCustomer": { + "ConsentsRequestConsentDetailDataFilterItem": { "type": "object", "properties": { - "id": { + "operator": { + "type": "string", + "enum": [ + "=", + "!=", + ">", + "<", + ">=", + "<=" + ], + "description": "Operator to filter data by." + }, + "type": { + "type": "string", + "enum": [ + "TRANSACTIONTYPE", + "TRANSACTIONAMOUNT" + ], + "description": "The condition to filter the data on." + }, + "value": { "type": "string", - "description": "Customer Address" + "description": "Value to filter data" } - } + }, + "required": [ + "operator", + "type", + "value" + ] + }, + "ConsentsRequestConsentDetailFrequency": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "HOUR", + "DAY", + "MONTH", + "YEAR", + "INF" + ], + "description": "Defines the time unit of the frequency to access the financial information." + }, + "value": { + "type": "integer", + "description": "Define the number of times FI data can be fetched within the defined time unit." + } + }, + "required": [ + "unit", + "value" + ] }, - "CreateConsentsRequest": { + "CreateConsentRequestV2": { "type": "object", "properties": { "PAN": { "type": "string", "pattern": "^$|[A-Z]{5}[0-9]{4}[A-Z]{1}" }, - "redirectUrl": { + "consentDuration": { + "description": "How long consumer is allowed to store data", + "allOf": [ + { + "$ref": "#/components/schemas/ConsentDurartion" + } + ] + }, + "fetchType": { "type": "string", - "description": "URL to redirect to after completion of consent journey" + "enum": [ + "ONETIME", + "PERIODIC" + ] }, "context": { "type": "array", @@ -5490,63 +3421,46 @@ ] } }, - "Detail": { - "description": "Specify the financial information types that customer wants to access", + "frequency": { + "description": "Defines frequency of FI data fetch within the defined time unit. E.g.HOURLY,DAILY,MONTHLY,YEARLY.The maximum frequency value that can be defined is 1 request per HOUR. Similaraly it will be 24 requests per DAY and so on. Frequency can not be set below 1 request per hour.", "allOf": [ { - "$ref": "#/components/schemas/ConsentsRequestConsentDetail" + "$ref": "#/components/schemas/ConsentsRequestConsentDetailFrequency" } ] - } - }, - "required": [ - "Detail" - ] - }, - "ConsentsRequestConsentDetail": { - "type": "object", - "properties": { - "fetchType": { - "type": "string", - "enum": [ - "ONETIME", - "PERIODIC" - ], - "description": "FI Fetch type. Could be ONETIME or PERIODIC" - }, - "consentMode": { - "type": "string", - "enum": [ - "VIEW", - "STORE", - "QUERY", - "STREAM" - ], - "description": "Consent Mode as defined in the AA Technical Specification" }, - "Customer": { - "description": "Contains the customer address", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailCustomer" - } - ] + "dataFilter": { + "type": "array", + "description": "rules that will be utilized by FIP to filter the data", + "items": { + "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataFilterItem" + } }, - "Purpose": { + "purpose": { "description": "Purpose of the consent defined in the AA Technical Specification", "allOf": [ { - "$ref": "#/components/schemas/ConsentDetailPurpose" + "$ref": "#/components/schemas/ConsentRequestPurpose" } ] }, - "FIDataRange": { - "description": "Specify the datetime range for querying the financial information", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange" - } - ] + "consentTypes": { + "type": "array", + "x-minimum": 1, + "items": { + "type": "string", + "enum": [ + "PROFILE", + "SUMMARY", + "TRANSACTIONS" + ] + } + }, + "redirectUrl": { + "type": "string" + }, + "dataRange": { + "$ref": "#/components/schemas/ConsentsRequestConsentDetailFIDataRange1" }, "fiTypes": { "type": "array", @@ -5578,24 +3492,13 @@ "description": "List of financial information types." } }, - "consentExpiry": { - "type": "string", - "format": "date-time", - "description": "Expiry date-time for the consent" + "vua": { + "type": "string" }, - "consentTypes": { - "type": "array", - "x-minimum": 1, - "items": { - "type": "string", - "enum": [ - "PROFILE", - "SUMMARY", - "TRANSACTIONS" - ] - } + "consentDateRange": { + "$ref": "#/components/schemas/ConsentDateRange" }, - "DataLife": { + "dataLife": { "description": "How long consumer is allowed to store data", "allOf": [ { @@ -5603,72 +3506,95 @@ } ] }, - "Frequency": { - "description": "Defines frequency of FI data fetch within the defined time unit. E.g.HOURLY,DAILY,MONTHLY,YEARLY.The maximum frequency value that can be defined is 1 request per HOUR. Similaraly it will be 24 requests per DAY and so on. Frequency can not be set below 1 request per hour.", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailFrequency" - } - ] - }, - "DataFilter": { - "type": "array", - "description": "rules that will be utilized by FIP to filter the data", - "items": { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataFilterItem" - } - }, - "consentStart": { + "consentMode": { + "type": "string", + "enum": [ + "VIEW", + "STORE", + "QUERY", + "STREAM" + ], + "description": "Consent Mode as defined in the AA Technical Specification" + } + }, + "required": [ + "dataRange", + "vua" + ] + }, + "ConsentDateRange": { + "type": "object", + "properties": { + "endDate": { "type": "string", "format": "date-time", - "description": "Start date-time of the consent. This field would allow for Post-Dated consent." + "description": "Expiry date-time for the consent" }, - "DataConsumer": { - "description": "Contains the FIU id", - "allOf": [ - { - "$ref": "#/components/schemas/ConsentsRequestConsentDetailDataConsumer" - } - ] + "startDate": { + "type": "string", + "format": "date-time", + "description": "Expiry date-time for the consent" } }, "required": [ - "Customer", - "DataConsumer", - "DataLife", - "FIDataRange", - "Frequency", - "Purpose", - "consentExpiry", - "consentMode", - "consentStart", - "consentTypes", - "fetchType", - "fiTypes" + "endDate", + "startDate" ] }, - "ConsentsRequestConsentDetailDataConsumer": { + "ConsentRequestPurpose": { "type": "object", "properties": { - "id": { + "code": { + "type": "string", + "enum": [ + "101", + "102", + "103", + "104", + "105", + "106" + ], + "description": "Purpose Code as defined in the AA Technical Specification " + }, + "text": { + "type": "string", + "description": "Textual Description" + }, + "category": { + "$ref": "#/components/schemas/PurposeCategory1" + }, + "refUri": { "type": "string", - "description": "The identifier of the FIU" + "description": "URL where the purpose is further defined" } }, "required": [ - "id" + "category", + "code", + "refUri", + "text" ] }, - "ConsentsRequestConsentDetailCustomer": { + "ConsentDurartion": { "type": "object", "properties": { - "id": { + "unit": { "type": "string", - "description": "The identifier of the Customer can be generated during the registration with AA" + "enum": [ + "MONTH", + "YEAR", + "DAY" + ], + "description": "A unit of how long consumer can store the data" + }, + "value": { + "type": "integer", + "description": "Define the value of unit of how long can consumer store the data" } }, "required": [ - "id" + "unit", + "value" ] }, "FIPResponse": {