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

Integration

If the individual has connected their account using Atto Connect, you can use the GET /income-verification/v1/consents/{consentId}/verifications endpoint to verify an individual's income.

Authorization

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

Gets the income verifications for the accounts shared for a consent.

Request

Security
Bearer
Path
consentIdstringrequired

The consent ID to fetch the income verifications results for

Query
accountIdstring

The account ID to fetch the income verification for. If not specified, all accounts associated with this session are returned

includeFlagsboolean

Includes the flags used to calculate the confidence score

Default false
excludeBenefitsboolean

Excludes the benefits from the income streams

Default false
curl -i -X GET \
  'https://uk.api.atto.co/income-verification/v1/consents/{consentId}/verifications?accountId=string&includeFlags=false&excludeBenefits=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Income Verification results for the accounts linked to this consent

Bodyapplication/jsonArray [
accountDetailsobject(DirectID.Data.API.Models.IncomeVerification.Response.Connect.AccountDetails)
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:
verifiedIncomeStatusstring(DirectID.Data.Common.Models.Account.VerifiedIncomeStatus)
Enum"UnsupportedAccountType""NoCreditTransactions""Processed"
]
Response
application/json
[ { "accountDetails": {}, "incomeStreams": [], "incomeStreamsSummary": {}, "verifiedIncomeStatus": "UnsupportedAccountType" } ]
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations