Consents

Manage user consent objects created through the Sessions API
post
Get Consent
https://api.finqware.com/v1/consents/get
This endpoint allows a tenant app to check the status for a consent object.
Request
Response
Request
Body Parameters
client_id
required
string
An identifier for your tenant app.
client_secret
required
string
A tenant app secret.
credentials_id
required
string
A pointer to the consent object.
access_token
required
string
An authorization token for this particular consent object.
Response
200: OK
Consent successfully retrieved.
{
    "op_type": "read",
    "code": "credentials_info",
    "http": 200,
    "message": "Consent info retrieved",
    "result": {
        "credentials_id": "519e...25fd5",
        "originator": {
            "country": "Romania",
            "servicer": "Raiffeisen Bank Romania",
            "skill": "rzb_ro_aisp_sbx_#1.0"
        },
        "status": "ACTIVE",
        "tenant_app_info": {
            "client_id": "8fbc3f...d4dc58b1",
            "name": "psd2-tests"
        },
        "utc_created": "2020-07-05T21:48:06Z",
        "utc_last_update": "2020-07-05T21:48:27Z",
        "consent_exp": "2020-11-03T11:22:54Z",
        "max_data_retention": "2020-12-03T11:22:54Z"
    }
}
post
Delete Consent
https://api.finqware.com/v1/consents/delete
The delete operation updates the state of a given consent from ACTIVE to DELETED.

A DELETED consent pointed by its credentials_id cannot be used anymore to retrieve account data (accounts, balances, transactions).

This is an idempotent operation.
Request
Response
Request
Body Parameters
client_id
required
string
An identifier for your tenant app
client_secret
required
string
A tenant app secret.
credentials_id
required
string
A pointer to the consent object.
access_token
required
string
An authorization token for this particular consent object.
pcd_data_retention
optional
integer
How long (in minutes) will the cached data be retained in the cache after consent deletion.
Response
200: OK
The consent was successfully deleted.
{
    "code": "credentials_deleted",
    "http": 200,
    "message": "Consent deleted",
    "op_type": "delete",
    "result": {
        "client_id": "8fbc3f...dc58b1",
        "credentials_id": "519e5...225fd5"
    }
}
API - Previous
Payments
Next - API
Catalogs
Last updated 8 months ago
Consents

postGet Consent

postDelete Consent

post
Get Consent

post
Delete Consent
