Optional filter to get consents only for a particular configuration name for the client.
Atto Developer Documentation (all)
Download OpenAPI description
Overview
URL
API Support
License
Languages
Servers
UK Environment (Production)
https://uk.api.atto.co/
US Environment (Production)
https://us.api.atto.co/
This allows you to retrieve details for consents such as expiry date, status, provider, permissions and any other detail about the consent that has been stored.
Query
Optional filter to get consents with a particular status.
Enum"Pending""Active""Revoked""Abandoned""Failed""Expired"
Optional filter to get consents of a particular type (OpenBanking vs. CreditInformation).
Enum"OpenBanking""CreditInformation"
Optional filter to get consents which have been created/updated after the from date.
Optional filter to get consents which have been created/updated before the to date.
- UK Environment (Production)
https://uk.api.atto.co/consents/v2
- US Environment (Production)
https://us.api.atto.co/consents/v2
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://uk.api.atto.co/consents/v2?configurationName=string&consentStatus=Pending&providerId=0&customerReference=string&userId=string&dataSourceType=OpenBanking&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&offset=0&limit=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Returns the list of consents.
Type of the consent based on duration.
Enum"Single""Limited""Infinite"
Enum"Pending""Active""Revoked""Abandoned""Failed""Expired"
Number of days of transactions that can be requested from the bank.
Used to indicate the type of journey that was performed If null it means the default(initial) journey was performed.
Enum"Reauthentication""Reconfirmation"
Response
application/json
[ { "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "providerId": 0, "providerName": "string", "configurationName": "string", "customerReference": "string", "consentDurationType": "Single", "consentStatus": "Pending", "consentStart": "2019-08-24T14:15:22Z", "consentEnd": "2019-08-24T14:15:22Z", "duration": "string", "daysOfHistoricalTransactions": 0, "statusUpdated": "2019-08-24T14:15:22Z", "statusDetails": "string", "permissions": [ … ], "invitationId": "string", "journeyType": "Reauthentication" } ]
- UK Environment (Production)
https://uk.api.atto.co/consents/v1/{consentId}
- US Environment (Production)
https://us.api.atto.co/consents/v1/{consentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://uk.api.atto.co/consents/v1/{consentId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "providerId": 0, "providerName": "string", "configurationName": "string", "customerReference": "string", "consentDurationType": "Single", "consentStatus": "Pending", "consentStart": "2019-08-24T14:15:22Z", "consentEnd": "2019-08-24T14:15:22Z", "duration": "string", "daysOfHistoricalTransactions": 0, "statusUpdated": "2019-08-24T14:15:22Z", "statusDetails": "string", "permissions": [ "string" ], "invitationId": "string", "journeyType": "Reauthentication" }