Processes the income verifications for the accounts supplied.

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

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

Income Verification Engine

Operations

Authentication

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

Processes the income verifications for the accounts supplied.

Request

Security

Bearer

Body

accountIdstringnon-emptyrequired

Unique identifier for the account to be verified for income

includeFlagsboolean

Includes the flags used to calculate the confidence score

excludeBenefitsboolean

Excludes the benefits from the income streams

currencyCodestringnon-emptyrequired

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

transactionsArray of objects or null(DirectID.Data.API.Models.IncomeVerification.Request.API.IncomeVerificationTransaction)

curl -i -X POST \
  https://uk.api.atto.co/insights-engine/v1/income-verification \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "accountId": "string",
    "includeFlags": true,
    "excludeBenefits": true,
    "currencyCode": "string",
    "transactions": [
      {
        "transactionId": "string",
        "description": "string",
        "amount": 0.1,
        "creditDebitIndicator": "Credit",
        "status": "Pending",
        "bookingDate": "string"
      }
    ]
  }'

Responses

Income Verification result for the supplied accounts

Bodyapplication/jsonArray [

accountIdstring or null

incomeStreamsArray of objects or null(DirectID.Data.API.Models.IncomeVerification.Response.IncomeStream)

incomeStreamsSummary(DirectID.Data.API.Models.IncomeVerification.Response.IncomeStreamsSummary (object or null)) or (DirectID.Data.API.Models.IncomeVerification.Response.IncomeStream (object or null))

One of:

]

Response

application/json

[
  {
    "accountId": "string",
    "incomeStreams": [ … ],
    "incomeStreamsSummary": { … }
  }
]

Affordability Engine

Operations

Get Statement

Operations

Atto Developer Documentation (all)

Get Token

Connect Invitation

Get Consents

Revoke Consent

Bank Account Verification

Bank Data

Income Verification

Affordability

Bank Data (stored)

Income Verification (stored)

Payment Account Confirmation

Affordability (stored)

Atto Score

Consumer Financial Health

Business Financial Health

Categorisation Engine

Income Verification Engine

Authentication

Processes the income verifications for the accounts supplied.

RequestExpand all

Responses

Was this helpful?

Affordability Engine

Get Statement

Request