API Reference
/
Get Consents
/
Retrieve list of consents.

Atto Developer Documentation (all)

Download OpenAPI description
index.json
index.yaml
Overview
URL https://www.atto.co/about/contact
API Support support@atto.co
License All Rights Reserved © The IDCO. Ltd
 Terms of Service
Languages
Servers
UK Environment (Production)
https://uk.api.atto.co/
US Environment (Production)
https://us.api.atto.co/

Get Token

Operations

Connect Invitation

Operations

Get Consents

Operations

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.

Retrieve list of consents.

Request

Query
consentStatusstring

Optional filter to get consents with a particular status.

configurationNamestring

Optional filter to get consents only for a particular configuration name for the client.

providerIdinteger(int32)

Optional filter to get consents only for a particular provider id.

customerReferencestring

Optional filter to get consents that match the customer reference exactly.

fromstring(date-time)

Optional filter to get consents which have been created/updated after the from date.

tostring(date-time)

Optional filter to get consents which have been created/updated before the to date.

userIdstring

Optional filter to get consents associated with userId

offsetinteger(int32)

Number of consents to skip.

Default 0
limitinteger(int32)

Maximum number of consents in the response.

Default 0
curl -i -X GET \
  'https://uk.api.atto.co/consents/v1?configurationName=string&consentStatus=string&customerReference=string&from=2019-08-24T14%3A15%3A22Z&limit=0&offset=0&providerId=0&to=2019-08-24T14%3A15%3A22Z&userId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the list of consents.

Bodyapplication/jsonArray [
consentIdstring(uuid)

Unique reference for the consent .

applicationIdstring(uuid)

Application Id for the client.

userIdstring(uuid)

Unique reference for the User the consent is associated with.

providerIdinteger(int32)

Provider Id for the consent.

providerNamestring or null

Provider name for the consent.

configurationNamestring or null

Specific configuration of the client.

customerReferencestring or null

Reference for the consent provided by the client.

consentDurationTypestring(ConsentDurationType)

Type of the consent based on duration.

Enum"Single""Limited""Infinite"
consentStatusstring(ConsentStatus)
Enum"Pending""Active""Revoked""Abandoned""Failed""Expired"
consentStartstring or null(date-time)

Start date for the consent.

consentEndstring or null(date-time)

End date for the consent.

durationstring or null

Duration of consent in ISO8601 format.

daysOfHistoricalTransactionsinteger or null(int32)

Number of days of transactions that can be requested from the bank.

statusUpdatedstring(date-time)

Date of last status update of the consent.

statusDetailsstring or null

Details for the current status.

permissionsArray of strings or null

List of permissions for the consent.

invitationIdstring or null

Associated Invitation Id

journeyTypestring(ConsentJourneyType)

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"
  }
]

Retrieve a consent by consent ID.

Request

Path
consentIdstringrequired

The consent ID to fetch the consent details for. This should be a uuid.

curl -i -X GET \
  'https://uk.api.atto.co/consents/v1/{consentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the consent details.

Bodyapplication/json
consentIdstring(uuid)

Unique reference for the consent .

applicationIdstring(uuid)

Application Id for the client.

userIdstring(uuid)

Unique reference for the User the consent is associated with.

providerIdinteger(int32)

Provider Id for the consent.

providerNamestring or null

Provider name for the consent.

configurationNamestring or null

Specific configuration of the client.

customerReferencestring or null

Reference for the consent provided by the client.

consentDurationTypestring(ConsentDurationType)

Type of the consent based on duration.

Enum"Single""Limited""Infinite"
consentStatusstring(ConsentStatus)
Enum"Pending""Active""Revoked""Abandoned""Failed""Expired"
consentStartstring or null(date-time)

Start date for the consent.

consentEndstring or null(date-time)

End date for the consent.

durationstring or null

Duration of consent in ISO8601 format.

daysOfHistoricalTransactionsinteger or null(int32)

Number of days of transactions that can be requested from the bank.

statusUpdatedstring(date-time)

Date of last status update of the consent.

statusDetailsstring or null

Details for the current status.

permissionsArray of strings or null

List of permissions for the consent.

invitationIdstring or null

Associated Invitation Id

journeyTypestring(ConsentJourneyType)

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": [
    "string"
  ],
  "invitationId": "string",
  "journeyType": "Reauthentication"
}

Revoke Consent

Operations

Bank Account Verification

Operations

Bank Data

Operations

Income Verification

Operations

Affordability

Operations

Bank Data (stored)

Operations

Income Verification (stored)

Operations

Payment Account Confirmation

Operations

Affordability (stored)

Operations

Atto Score

Operations

Consumer Financial Health

Operations

Business Financial Health

Operations

Categorisation Engine

Operations

Income Verification Engine

Operations

Affordability Engine

Operations

Get Statement

Operations
API Support
Contact Us
Terms
All Rights Reserved © The IDCO. Ltd | Company registered in Scotland SC400459 | AISP registration number 798579 | Data Protection ICO number ZA384596