Skip to content
/Categorisation Engine

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

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

Integration

If you wish to categorise any transactions that you have, you can do so using the POST /insights-engine/v1/enrich-transactions endpoint. This will be using the data supplied via the endpoint in the request. Please ensure that this product is enabled for your app by talking to support before using this endpoint.

In response to your call, you will receive a JSON object containing the original transations with added classes and categories along with confidence score, and merchant name.

Authorization

This API requires a bearer token using the api:data scope

Adds categorisation, classification and predicts a merchant name for transactions supplied.

Request

Security
Bearer
Query
useLegacyCategorisationboolean

Flag whether to use the latest or legacy categorisation service

Default false
confidenceFloornumber(double)

Value from 0.0 to 1.0 which will return transactions as uncategorised if the category confidence is below this value

Default 0
Body

Request body for categorisation

referenceIdstringnon-emptyrequired

Unique identifier for the categorisation request

countryCodestringnon-emptyrequired

Country code for the account of the transactions

currencyCodestringnon-emptyrequired

Currency code for the transactions, currently supported codes are GBP and USD.

transactionsArray of objects or null(DirectID.Data.API.Models.Categorisation.Request.CategorisationTransaction)

Transaction data. Maximum limit for the number of transactions is 5000.

curl -i -X POST \
  'https://uk.api.atto.co/insights-engine/v1/enrich-transactions?useLegacyCategorisation=false&confidenceFloor=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "referenceId": "string",
    "countryCode": "string",
    "currencyCode": "string",
    "transactions": [
      {
        "transactionId": "string",
        "description": "string",
        "amount": 0.1,
        "creditDebitIndicator": "Credit",
        "status": "Pending",
        "bookingDate": "string"
      }
    ]
  }'

Responses

Categorisation result for the supplied transactions

Bodyapplication/jsonArray [
referenceIdstring or null

Unique identifier for the categorisation request

countryCodestring or null

Country code for the account of the transactions

currencyCodestring or null

Currency code for the transactions, currently supported codes are GBP and USD.

transactionsArray of objects or null(DirectID.Data.API.Models.Categorisation.Response.CategorisationTransactionResponse)
]
Response
application/json
[
  {
    "referenceId": "string",
    "countryCode": "string",
    "currencyCode": "string",
    "transactions": [ … ]
  }
]

Income Verification Engine

Operations

Affordability Engine

Operations

Get Statement

Operations

Accounts

Operations
API Support
Contact Us
Terms
Company registered in Scotland SC400459 • Atto is brought to you by The ID Co., a registered Account Information Service Provider by the FCA • AISP registration number 798579 • We're committed to protecting your data, our ICO number is ZA384596