SpareSpare Docs
GuidesAPI Reference

Connections & Consents

Create account connections and manage consent.

POST
/api/v1.0/ais/Connection/Create
Authorization
Query

Provider id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/ais/Connection/Create?providerId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "provider": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "country": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "englishName": "string",        "arabicName": "string",        "iso3166Code": "st",        "timeZone": "string"      },      "allowedPermissions": [        "ReadAccountsBasic"      ],      "address": "string",      "phone": "string",      "arabicName": "string",      "englishName": "string",      "status": "Active",      "isEnable": true,      "logo": "http://example.com"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "status": "ACTIVE",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/Connection/Get
Authorization
Query

Connection id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Connection/Get?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "provider": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "country": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "currency": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        },        "englishName": "string",        "arabicName": "string",        "iso3166Code": "st",        "timeZone": "string"      },      "allowedPermissions": [        "ReadAccountsBasic"      ],      "address": "string",      "phone": "string",      "arabicName": "string",      "englishName": "string",      "status": "Active",      "isEnable": true,      "logo": "http://example.com"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "status": "ACTIVE",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/Connection/List
Authorization
Query

Page number

Number of items per page maximum allow is 500 per page

Provider id (optional)

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Connection/List"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "provider": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "country": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "currency": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "englishName": "string",          "arabicName": "string",          "iso3166Code": "st",          "timeZone": "string"        },        "allowedPermissions": [          "ReadAccountsBasic"        ],        "address": "string",        "phone": "string",        "arabicName": "string",        "englishName": "string",        "status": "Active",        "isEnable": true,        "logo": "http://example.com"      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "ACTIVE",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "currentPageNumber": 0,    "pageSize": 0,    "totalNumberOfPages": 0,    "totalItems": 0  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
DELETE
/api/v1.0/ais/Connection/Delete
Authorization
Query

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1.0/ais/Connection/Delete?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
POST
/api/v1.0/ais/Consent/CreateShortLivedConsent
Authorization
Body
*object

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/ais/Consent/CreateShortLivedConsent" \  -H "Content-Type: application/json" \  -d '{    "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"  }'
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "expiryDate": "2019-08-24T14:15:22Z",    "transactionsFromDate": "2019-08-24T14:15:22Z",    "transactionsToDate": "2019-08-24T14:15:22Z",    "permissions": [      "string"    ],    "statusHistory": [      {        "status": "AwaitingAuthorization",        "dateTime": "2019-08-24T14:15:22Z"      }    ],    "connection": {      "provider": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "country": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "currency": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "englishName": "string",          "arabicName": "string",          "iso3166Code": "st",          "timeZone": "string"        },        "allowedPermissions": [          "ReadAccountsBasic"        ],        "address": "string",        "phone": "string",        "arabicName": "string",        "englishName": "string",        "status": "Active",        "isEnable": true,        "logo": "http://example.com"      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "ACTIVE",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "scope": "Accounts",    "createdAt": "2019-08-24T14:15:22Z",    "status": "AwaitingAuthorization",    "authorizationLink": "string",    "successRedirectUrl": "string",    "failureRedirectUrl": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
POST
/api/v1.0/ais/Consent/CreateLongLivedConsent
Authorization
Body
*object

Request Body

application/json

Long-lived consent request model

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/ais/Consent/CreateLongLivedConsent" \  -H "Content-Type: application/json" \  -d '{    "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "expiryDate": "2019-08-24T14:15:22Z"  }'
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "expiryDate": "2019-08-24T14:15:22Z",    "transactionsFromDate": "2019-08-24T14:15:22Z",    "transactionsToDate": "2019-08-24T14:15:22Z",    "permissions": [      "string"    ],    "statusHistory": [      {        "status": "AwaitingAuthorization",        "dateTime": "2019-08-24T14:15:22Z"      }    ],    "connection": {      "provider": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "country": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "currency": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "englishName": "string",          "arabicName": "string",          "iso3166Code": "st",          "timeZone": "string"        },        "allowedPermissions": [          "ReadAccountsBasic"        ],        "address": "string",        "phone": "string",        "arabicName": "string",        "englishName": "string",        "status": "Active",        "isEnable": true,        "logo": "http://example.com"      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "ACTIVE",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "scope": "Accounts",    "createdAt": "2019-08-24T14:15:22Z",    "status": "AwaitingAuthorization",    "authorizationLink": "string",    "successRedirectUrl": "string",    "failureRedirectUrl": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/Consent/List
Authorization
Query

Page number

Number of items per page maximum allow is 500 per page

Provider id (Optional)

Connection id (Optional)

Customer id (Optional)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Consent/List"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "expiryDate": "2019-08-24T14:15:22Z",      "transactionsFromDate": "2019-08-24T14:15:22Z",      "transactionsToDate": "2019-08-24T14:15:22Z",      "permissions": [        "string"      ],      "statusHistory": [        {          "status": "AwaitingAuthorization",          "dateTime": "2019-08-24T14:15:22Z"        }      ],      "connection": {        "provider": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "country": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z",            "currency": {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "englishName": "string",              "arabicName": "string",              "iso4117Code": "str",              "iso4117Number": "stri"            },            "englishName": "string",            "arabicName": "string",            "iso3166Code": "st",            "timeZone": "string"          },          "allowedPermissions": [            "ReadAccountsBasic"          ],          "address": "string",          "phone": "string",          "arabicName": "string",          "englishName": "string",          "status": "Active",          "isEnable": true,          "logo": "http://example.com"        },        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "status": "ACTIVE",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",      "scope": "Accounts",      "createdAt": "2019-08-24T14:15:22Z",      "status": "AwaitingAuthorization",      "authorizationLink": "string",      "successRedirectUrl": "string",      "failureRedirectUrl": "string"    }  ],  "meta": {    "currentPageNumber": 0,    "pageSize": 0,    "totalNumberOfPages": 0,    "totalItems": 0  }}
Empty
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/Consent/Get
Authorization
Query

Consent id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Consent/Get?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "expiryDate": "2019-08-24T14:15:22Z",    "transactionsFromDate": "2019-08-24T14:15:22Z",    "transactionsToDate": "2019-08-24T14:15:22Z",    "permissions": [      "string"    ],    "statusHistory": [      {        "status": "AwaitingAuthorization",        "dateTime": "2019-08-24T14:15:22Z"      }    ],    "connection": {      "provider": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "country": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "currency": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "englishName": "string",          "arabicName": "string",          "iso3166Code": "st",          "timeZone": "string"        },        "allowedPermissions": [          "ReadAccountsBasic"        ],        "address": "string",        "phone": "string",        "arabicName": "string",        "englishName": "string",        "status": "Active",        "isEnable": true,        "logo": "http://example.com"      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "ACTIVE",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "scope": "Accounts",    "createdAt": "2019-08-24T14:15:22Z",    "status": "AwaitingAuthorization",    "authorizationLink": "string",    "successRedirectUrl": "string",    "failureRedirectUrl": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
PATCH
/api/v1.0/ais/Consent/Revoke
Authorization
Query

Consent id

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1.0/ais/Consent/Revoke?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty

Account Information

Accounts, balances, transactions, statements, and consent connections.

Customers

Create, list, retrieve, update, and delete customer records.