Consent Request Status
Introduction
The Check Status API is a crucial component of the Account Aggregator ecosystem. It allows financial institutions to verify the status of data requests and user consents in real-time. This API helps determine whether a user has granted consent for data sharing and provides the current state of the request, such as whether it has succeeded, failed, or is still pending.
API Input Guidelines
Need to pass on the following information:
- A valid requestId generated via create consent request API or the FI request API
- A valid consent Handle Id in case of multi consent journey to check the status of a single consnent out of the multiple consents
curl --request POST \
--url https://api.signzy.app/api/v3/account-aggregator-switch/check-status \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data '{
"requestId" : "<UUID generated by Signzy>"
}'Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION | TYPE |
|---|---|---|---|
requestId | Required | RequestId generated after calling create consent request API or FI request API | String |
Sample Response
{
"result": {
"requestId": "bf75efbb-5604-42d8-8163-f29ca0f5c6",
"status": {
"flowStatus": "SUCCESS",
"consentStatus": "ACTIVE",
"dataFetchStatus": "SUCCESS"
}
}
}Response Parameter
PARAMETER NAME | DESCRIPTION | TYPE |
|---|---|---|
result | Result object which contains the response body | |
result.requestId | This holds final result parameters of the response. | |
result.status | Status object which has the details about different status | |
result.status.flowStatus | Flow status of the request, possible values can be:
| |
result.status.consentStatus | Status of the consent request, possible values are: • ACTIVE: Consent is active • REJECTED: Consent is rejected • PENDING: User has not acted on consent request • EXPIRED: Consent is expired • REVOKED: Consent is revoked by User. User can revoke a previously approved consent from AA App. • PAUSED: Consent is paused by User. User can pause a previously approved consent from AA App. | |
result.status.datFetchStatus | Status of the data fetch request, possible values can be: • SUCCESS: Data fetch is successful • FAILED: Data fetch is failed • PENDING: Finarkein is waiting for data from AA • RUNNING: Data fetch is in process | |
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].