POST api/FinanceValidation

Request Information

URI Parameters

None.

Body Parameters

BankAccountValidationRequest
NameDescriptionTypeAdditional information
RegistrationId

integer

None.

FirstName

string

None.

Surname

string

None.

IdentityType

string

None.

IdentityNumber

string

None.

BankAccountNumber

string

None.

BankBranchCode

string

None.

BankAccountType

string

None.

MobileNumber

string

None.

EMailAddress

string

None.

Request Formats

application/json, text/json

Sample:
{
  "registrationId": 1,
  "firstName": "sample string 1",
  "surname": "sample string 2",
  "identityType": "sample string 3",
  "identityNumber": "sample string 4",
  "bankAccountNumber": "sample string 5",
  "bankBranchCode": "sample string 6",
  "bankAccountType": "sample string 7",
  "mobileNumber": "sample string 8",
  "eMailAddress": "sample string 9"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BankAccountValidationResponse
NameDescriptionTypeAdditional information
ValidationSuccessful

boolean

None.

SystemError

boolean

None.

ValidationErrorMessage

string

None.

IdNumberIsValid

boolean

None.

BankAccountNumberValid

boolean

None.

BankAccountFound

boolean

None.

BankAccountAcceptsDebits

boolean

None.

BankAccountOpen

boolean

None.

BranchCodeValid

boolean

None.

IdNumberMatch

boolean

None.

NameMatch

boolean

None.

EmailMatch

boolean

None.

MobileNumberMatch

boolean

None.

MaxAttemptsExceeded

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "validationSuccessful": true,
  "systemError": true,
  "validationErrorMessage": "sample string 3",
  "idNumberIsValid": true,
  "bankAccountNumberValid": true,
  "bankAccountFound": true,
  "bankAccountAcceptsDebits": true,
  "bankAccountOpen": true,
  "branchCodeValid": true,
  "idNumberMatch": true,
  "nameMatch": true,
  "emailMatch": true,
  "mobileNumberMatch": true,
  "maxAttemptsExceeded": true
}