Please enable JavaScript.
Coggle requires JavaScript to display documents.
income/V2 - Coggle Diagram
income/V2
v2 API
Standardisation
Naming convention
enum values
field names
API model
Status codes
Pagination
Config (create)
Income result
Mutli-value result
simple result
Content Type
Date / timestamp (.net)
Required vs non-required input
Provided data
bank-statement
payslip
Endpoints
GET /{id}/riskAnalysis
failed transactions
debt collection
balance slope
GET /{id}/affordability
category - value table
credit repayments
GET/{id}/fraudAnalysis
Benfords's law
Editor blacklist
/incomeVerification/
{id}
/manualCapture
confirm
:ballot_box_with_check: POST
ConfirmFraud
Success
Failed
/transactions
/dryRun
POST
list of income transactions
[transactionIds]
returns result DTO
:ballot_box_with_check: POST
list of income transactions
[transactionIds]
:check: /manualIncome
POST
payDay
payments
date
amount
payCycle
accountHolderName
bankName
bankAccountNumber
:ballot_box_with_check: /transactions
GET
list of transactions
:check: deaConsent/
POST
deaConsent
initials
emailAddress
lastName
firstName
bankAccountNumber
branchCode
idNumber
consentGiven
providerBusinessUnit
businessUnit
:check: GET
correlationId
applicant details
declaration
config
:ballot_box_with_check: /state
GET
result
analysis result
status
within tolerance
outside tolerance
none
confirmed
source
automation
manual
status
Failed
Confirmed fraud
In Progess
Success
Refer to Fraud
evidence-state
payslips
banks-statements
???reason???
/document
/{docId}
:ballot_box_with_check:: GET
type
uploadTime
hash
links in doc-man
status
validation failed
no extracted data
too old
aplicant mismatch
used
source (upload, email, dea, etc)
:ballot_box_with_check: GET
returns a list of linked documents
:check: POST
upload and link a new document
POST
:check: create a new INV
correlationId
applicant details
currentEmployeeNumber
taxNo
passportNumber
middleNames
lastName
bankAccountNumber
idNumber
firstName
initials
title
emailAddress
declaration
payCycleInDays
nettIncome
grossIncome
config
playslip
minDaysRequired
maxAgeInDays
noDocsRequired
bankStatement
minDaysRequired
maxAgeInDays
noDocsRequired
bankStatementAndPayslipRequired
timeOutMinutes
:ballot_box_with_check: GET
request params with SpringData query
(see work-item)
pageable list of INVs
Things to think about
Manual linking end states results in all documents not being able to linked
Documents have their own lifecycle
Doc Linker has a matching request timeout
What do the icons mean?
:check: It has been added to the JIRA board and implemented
:ballot_box_with_check: Has been added to JIRA but not implemented yet