FI Request

Introduction

This API is used to make recurring data fetch requests. If a peridoc consent is taken from the customer, this API will be used to create a new data fetch request in future after the onboarding is done for monitoring, PFM purposes.

API Input Guidelines

Need to pass on the following information:

consentHandle ID

Preproduction

Production

curl --request POST \
  --url https://api-preproduction.signzy.app/api/v3/account-aggregator-switch/fi-request \
  --header 'Authorization: <token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"consentHandle": "<The consent Handle Id generated at the create consent request>"
	
}'

curl --request POST \
  --url https://api.signzy.app/api/v3/account-aggregator-switch/fi-request \
  --header 'Authorization: <token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"consentHandle": "<The consent Handle Id generated at the create consent request>"
	
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION	TYPE
consentHandle	Required	Unique consentHandle Id received in create consent request API	String

Sample Response

{
    "result": {
        "requestId": "<signzy-generated-reqId>",
        "internalId": "<internal->"
    }
}

Output Parameter

PARAMETER NAME	DESCRIPTION
result	This holds final result parameters of the response.
result.requestId	Unique Request Id generated for the user.
result.internalId	The Request Id given by the AA.

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 AA's 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].