The consent ID to fetch the income verifications results for
Atto Developer Documentation (all)
Download OpenAPI description
Overview
URL
API Support
License
Languages
Servers
UK Environment (Production)
https://uk.api.atto.co/
US Environment (Production)
https://us.api.atto.co/
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.
- UK Environment (Production)https://uk.api.atto.co/income-verification/v1/consents/{consentId}/verifications
- US Environment (Production)https://us.api.atto.co/income-verification/v1/consents/{consentId}/verifications
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'Income Verification results for the accounts linked to this consent
incomeStreamsSummary(DirectID.Data.API.Models.IncomeVerification.Response.IncomeStreamsSummary (object or null)) or (DirectID.Data.API.Models.IncomeVerification.Response.IncomeStream (object or null))
One of:
Enum"UnsupportedAccountType""NoCreditTransactions""Processed"
Response
application/json
[ { "accountDetails": { … }, "incomeStreams": [ … ], "incomeStreamsSummary": { … }, "verifiedIncomeStatus": "UnsupportedAccountType" } ]