Consent 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.
This API tells whether the user consented for us to be able to retrieve the required financial details.
API Input Guidelines
Need to pass on the following information:
- Mobile Number
- Consent Handle ID
Sample Curl
curl --location 'https://api.signzy.app/api/v3/accountAggregator/consent-status' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
"mobileNumber" : "9783855XXX",
"consentHandleId" : "a3cc0c32-1369-4dd6-bc55-dbd2ece330bc"
}'Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION | TYPE |
|---|---|---|---|
mobileNumber | Required | Mobile number of the user | String |
consentHandleId | Required | Consent Handle Id - recevied when consent request was raised | String |
Sample Response
{
"result": {
"consentStatus": "ACCEPTED",
"consentId": "288feb05-4932-4861-89e9-339fa304885b"
}
}Response Parameter
PARAMETER NAME | DESCRIPTION | TYPE |
|---|---|---|
result | This holds final result parameters of the response. |  |
result.consentStatus | status; whether the user has given consent for the information to be retrieved | String |
result.consentId | Consent id generated after the user accepts the consent 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].