Skip to content

Atto Developer Documentation (all)

Download OpenAPI description
Languages
Servers
UK Environment (Production)

https://uk.api.atto.co/

US Environment (Production)

https://us.api.atto.co/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Authentication

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

Errors

Accounts must pass validation before a score can be generated. If validation fails, then requests to GET /atto-score/v1/consents/{consentId}/accounts/{accountId} will produce a 422 Unprocessable Entity response. Only the first validation failure encountered will be stored and returned on request.

{
    "code": "atto_score_not_generated",
    "description": "Atto Score could not be generated.",
    "details": "<see table below for all possible failure reasons>",
    "correlationId": "string"
}
Possible Failures
No transactions
Account is not a GBP account
Account is not a Personal account
Account is not a Current account
The minimum transaction period of 90 days was not met
The minimum transaction count of 50 was not met
Transactions without BookingDate
Account balances are null

Request

Security
Bearer
Path
consentIdstringrequired

The consent ID for which we want to fetch the atto-score

accountIdstringrequired

The account ID for which we want to fetch the atto-score

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

Responses

Atto Score result for the account specified

Bodyapplication/json
dataobject(DirectID.Insights.Service.Models.AdvancedInsights.AttoScore.AttoScoreData)
metaobject(DirectID.Data.Common.Response.EmptyMetaData)

No meta data corresponding to the response payload

object(DirectID.Data.Common.Response.EmptyMetaData)

No meta data corresponding to the response payload

Response
application/json
{ "data": { "accountId": "string", "attoScore": 0, "probabilityOfDefault": 0.1, "dateGenerated": "string", "version": "string", "range": {} }, "meta": {} }
Operations
Operations
Operations
Operations
Operations
Operations
Operations