Search
K
financials v1

AccountVerificationDetailDto

object
statusstring

status of account verification Allowed Values: [ MATCH, NAME_PARTIAL_MATCH, NAME_PARTIAL_MATCH_TYPE_NO_MATCH, NO_MATCH, UNABLE_TO_MATCH, ERROR, TIMEOUT, TYPE_NO_MATCH, ACCOUNT_VERIFICATION_NOT_RUN ]

Match pattern:^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$

Example:NAME_PARTIAL_MATCH

partnerReasonCodestring

Reason code sent from third party system for account verification.

Code Description
ANNM Account Name does Not Match
MBAM There may be a match on the Account name
BANM Business account, name matches
PANM Personal account, name matches
BAMM Business account, name may be a match
PAMM Personal account, name may be a match
AC01 Incorrect Account Number
IVCR Invalid Customer Reference
ACNS Account type Not Supported for CoP
OPTO Opted out of CoP Scheme
CASS Account has been switched
SCNS Sort code not supported at endpoint
verifiedboolean

denotes in the account details are verified

acceptedAtstring(date-time)

timestamp recorded when the consent was given for the account

acceptedBystring

id of the user who gave the consent for the account

actualNamestring

Actual name of given account received from CoP in case of partial match

isManualOverrideAllowedboolean

Flag to indicate if manual override is allowed

Example

LineItemDto

object
lineItemIdstring(uuid)

UUID of the corresponding line item

Example:c7c0ee40-25c1-11ec-9621-0242ac130002

typestring

Allowed values:
[SOURCE, DESTINATION]

Match pattern:^(SOURCE|DESTINATION)$

Example:SOURCE

amountnumber

Amount to be credited / debited

>= 1<= 999999999999.99

Example:10

authorisedboolean

Authorisation status of the line item

Example:true

referencestring

Match pattern:^[a-zA-Z0-9\/\-\\?:().,'#=!"%&*<>;@{+\s]*$

>= 1 characters<= 18 characters

Example:Nation wide

categorystring

Allowed values for source line item:
[Mortgage Advance]

Allowed values for destination line item:
[Redemption, Conveyancing Fees, Surplus, Onward Funds]

lineItemReferencestring

Example:PEXA220000003D01

bankAccountobject

This field is required and can be updated only for type DESTINATION.

Show Child Parameters
verificationDetailobject
Show Child Parameters
hasLinkedAccountboolean

Flag to indicate whether account is a linked account

Example

LineItemResponse

object
dataobject
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
Example

FinancialSettlementScheduleParticipant

object
subscriberIdstring(uuid)

Example:59a02f78-79c2-49ff-b27f-5606b4cda762

rolestring

Example:INCOMING_LENDER

Example

Email

string

Match pattern:^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])

>= 1 characters

Example