Financial request status

Introduction

Account Aggregator is a decentralized data sharing system that allows regulated entities to share user data amongst each other through a consent-based user flow. This data currently contains only transactional data from the bank account. Other variables are going to be added by the AA ecosystem in the future.

An Api to check the status of financial information of the customer for which the request was raised.

Sample cURL Request

Preproduction

Production

curl --location 'https://api-preproduction.signzy.app/api/v3/accountAggregator/FI-request-status' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
	"customerId": "9783855XXX",
	"consentId": "91d82e29-d9ae-4a52-8650-eca675c903f0",
	"sessionId" : "3d9f8823-e845-447d-a278-5dc1bff92bbe",
	"consentHandleId": "a3cc0c32-1369-4dd6-bc55-dbd2ece330bc"
}'

curl --location 'https://api.signzy.app/api/v3/accountAggregator/FI-request-status' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
	"customerId": "9783855XXX",
	"consentId": "91d82e29-d9ae-4a52-8650-eca675c903f0",
	"sessionId" : "3d9f8823-e845-447d-a278-5dc1bff92bbe",
	"consentHandleId": "a3cc0c32-1369-4dd6-bc55-dbd2ece330bc"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION	TYPE
customerId	Required	Mobile number of the user	String
consentId	Required	consent id of the user (received only when the user accepts the consent request)	String
sessionId	Required	SessionId (Unique Id to track FI request status)	String
consentHandleId	Required	Consent Handle Id - recevied when consent request was raised	String

Sample Response

{
    "result": {
        "fiRequestStatus": "READY"
    }
}

Response Parameter

PARAMETER NAME	DESCRIPTION	TYPE
result	This holds final result parameters of the response.
result.fiRequestStatus	Status of the FI fetch request	String

Error Codes

Error Code	Description
400	Bad Request: In case the request is not as per required schema or any other case
401	Unauthorized: Authentication failed or user does not have permissions for requested operation.
409	Upstream Error/Conflict: Something wrong on vendor side.
500	Internal Server Error: An error occurred on the server.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].