Account Aggregator Switch

Create Consent Request

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. Other variables will be added by the AA ecosystem in the future.
To retrieve the required financial details of the user, the API will respond with a 
API Input Guidelines
Need to pass on the following information:
A valid Mobile number
A valid ConsentTemplateId
A valid RedirectUrl
A valid Identifiers object
Pan
Email
Dob
A valid Webhook object
ConsentStatus
DataPush
FlowRunStatus 
Preproduction
Production
Curl
curl --request POST \
  --url https://api-preproduction.signzy.app/api/account-aggregator-switch/consent-request \
  --header 'Authorization: <token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"mobileNumber" : "<mobile-number>",	
	"consentTemplateId" : "<consent-TemplateId>",
	"redirectUrl" : "<redirect-Url>",
	 "identifiers": {
        "pan": "<pan>",
        "email": "<email>",
        "dob": "<Date-of-birth>"
    },
    "webhook": {
        "consentStatus": "<consent-Status>",
        "dataPush": "<data-Push>",
        "flowRunStatus": "<flow-Run-Status>"
    }
}'
curl --request POST \
  --url https://api-preproduction.signzy.app/api/account-aggregator-switch/consent-request \
  --header 'Authorization: <token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"mobileNumber" : "<mobile-number>",	
	"consentTemplateId" : "<consent-TemplateId>",
	"redirectUrl" : "<redirect-Url>",
	 "identifiers": {
        "pan": "<pan>",
        "email": "<email>",
        "dob": "<Date-of-birth>"
    },
    "webhook": {
        "consentStatus": "<consent-Status>",
        "dataPush": "<data-Push>",
        "flowRunStatus": "<flow-Run-Status>"
    }
}'
﻿
Curl
curl --request POST \
  --url https://api.signzy.app/api/v3/accountAggregator/consent-request \
  --header 'Authorization: <token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"mobileNumber" : "<mobile-number>",	
	"consentArtifactName" : "<artifact-name>",
	"consentDescription" : "<description>",
	"callbackUrl": "<url-link>"
}'
curl --request POST \
  --url https://api.signzy.app/api/v3/accountAggregator/consent-request \
  --header 'Authorization: <token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"mobileNumber" : "<mobile-number>",	
	"consentArtifactName" : "<artifact-name>",
	"consentDescription" : "<description>",
	"callbackUrl": "<url-link>"
}'
﻿
Input Parameters
PARAMETER NAME
REQUIRED/OPTIONAL
DESCRIPTION
TYPE
mobileNumber
Required
Mobile number of the user
String
consentTemplateId
Required
consentTemplateId (This is the identify if the user wants to fetch details onetime or periodic)
String
redirectUrl
Optional
redirectUrl is the url where the user will be directed to after the consent is 
String
identifiers.pan
Optional
The pan Id of the user 
String
identifiers.email
Optional
The email of the user
String
identifiers.dob
Optional
The date of birth of the user
String
webhook.consentStatus
Optional
The webhook to post consentStatus id
﻿
webhook.dataPush
Optional
The webhook to post the data
﻿
webhook.flowRunStatus
Optional
The webhook to flow Run status
﻿
Sample Response
JSON
{
    "result": {
     "requestId": "<signzy-generated-reqId>",
     "internalId": "<internal->",
     "consentHandle": "<consentHandleId>",
     "redirectUrl": "<redirect-Url>"
    }
}
{
    "result": {
     "requestId": "<signzy-generated-reqId>",
     "internalId": "<internal->",
     "consentHandle": "<consentHandleId>",
     "redirectUrl": "<redirect-Url>"
    }
}
﻿
Response Parameter
PARAMETER NAME
DESCRIPTION
TYPE
result
This holds final result parameters of the response.
﻿
result.requestId
Unique Request Id generated for the user.
String
result.consentHandle
consent handle Id (used for tracking the consent approval status).
String
result.internalId
The Request Id given by the AA.
String
result.redirectUrl
Redirectional Url 
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 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].
﻿

Overview

Check Status

Docs powered by Archbee

TABLE OF CONTENTS

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION	TYPE
mobileNumber	Required	Mobile number of the user	String
consentTemplateId	Required	consentTemplateId (This is the identify if the user wants to fetch details onetime or periodic)	String
redirectUrl	Optional	redirectUrl is the url where the user will be directed to after the consent is	String
identifiers.pan	Optional	The pan Id of the user	String
identifiers.email	Optional	The email of the user	String
identifiers.dob	Optional	The date of birth of the user	String
webhook.consentStatus	Optional	The webhook to post consentStatus id
webhook.dataPush	Optional	The webhook to post the data
webhook.flowRunStatus	Optional	The webhook to flow Run status

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.

Create Consent Request

Introduction

API Input Guidelines

Input Parameters

Sample Response

Response Parameter

Error Codes

﻿

Getting help