Spaces:
Build error
Build error
File size: 22,886 Bytes
48e7216 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
import datetime
import re
from pydantic import (
BaseModel,
Field,
ValidationInfo,
computed_field,
model_validator,
ConfigDict
)
import pandas as pd
class UKBankAccountStatement(BaseModel):
model_config = ConfigDict(arbitrary_types_allowed=True)
statement_start_date: datetime.date | None = Field(
default=None,
description="Digital Bank account statement period's start date in YYYY-MM-DD format",
examples=["2025-01-01"],
)
statement_end_date: datetime.date | None = Field(
default=None,
description="Digital Bank account statement period's end date in YYYY-MM-DD format",
examples=["2025-01-31"],
)
first_salary_deposit_date_present: int | datetime.date | None = Field(
default=None,
description=(
"The day/date of the very first salary deposit line item present in"
" the bank account statement. Value must be gte 1 & lte 31"
),
examples=[
"If first present salary deposit date is 2025-01-06, then 6 must be passed"
],
)
bank_name: str | None = Field(
default=None,
description="Extracted bank name value, stripped of whitespaces at beginning & end",
examples=["HSBC"],
) # , min_length=4, max_length=50)
full_name: str | None = Field(
default=None,
description="Applicant's full name. Must consist of at least 2 words, have length gte 2 & lte 61",
examples=["Jodie Pippa"],
) # , min_length=2, max_length=61)
account_number: str | None = Field(
default=None,
description="UK Bank Account Statement's account number. Must be of 8 characters length only",
examples=["12345678"],
) # , min_length=8, max_length=8) # 12345678
sort_code: str | None = Field(
default=None,
description="UK Bank Account Sort Code. Must be of length 8 characters only. Format: xx-xx-xx",
examples="20-00-00",
) # , min_length=8, max_length=8) # 20-00-00
# is_salary_credit_consistent_across_months: bool = Field(
# default=False,
# description=(
# "If the bank account statement spans several months, sense check "
# "whether salary deposit amounts across months are consistent"
# ),
# examples=[True, False, None],
# )
account_statement_date_err_msgs: str | None = None
full_name_err_msgs: str | None = None
bank_name_err_msgs: str | None = None
account_number_err_msgs: str | None = None
sort_code_err_msgs: str | None = None
salary_deposit_err_msgs: str | None = None
validation_policy_status_df: pd.DataFrame = pd.DataFrame(
columns=["Policy", "Value", "Status", "Message"])
@model_validator(mode="after")
def validate_full_name(cls, values, info: ValidationInfo):
"""Match applicant's full name against provided name (case-insensitive)"""
try:
err_msgs = []
expected = (
info.context.get("application_summary_full_name")
if info.context
else None
)
full_name_val = values.full_name
if not full_name_val:
err_msgs.append("Applicant's full name not present")
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Full Name",
full_name_val,
False,
"Applicant's full name not present",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Full Name",
full_name_val,
True,
"Applicant's full name is present",
]
full_name_val_len = 0
if full_name_val:
full_name_val_len = len(full_name_val)
if not full_name_val and not (
full_name_val_len >= 2 and full_name_val_len <= 61
):
err_msgs.append(
"Full name must have a length of at least 2 & at most 61"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Full Name",
full_name_val_len,
False,
"Full name does not have a length of at least 2 & at most 61",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Full Name",
full_name_val_len,
True,
"Full name has a length of at least 2 & at most 61",
]
if (
not expected
or not full_name_val
or full_name_val.lower() != expected.lower()
):
err_msgs.append("Name mismatch with provided value")
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Data Match",
f"{full_name_val}, {expected}",
False,
"Name does not match with provided value",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Data Match",
f"{full_name_val}, {expected}",
True,
"Name matches with provided value",
]
if not full_name_val or len(full_name_val.strip().split(" ")) < 2:
err_msgs.append(
"Full name must consist of at least 2 words (first name + last name)"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Full Name",
full_name_val,
False,
"Full name does not consist of at least 2 words (first name + last name)",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Full Name",
full_name_val,
True,
"Full name consists of at least 2 words (first name + last name)",
]
if err_msgs:
values.full_name_err_msgs = ", ".join(err_msgs)
else:
values.full_name_err_msgs = None
return values
except Exception as e:
# logger.exception(e, exc_info=True)
# return None
raise
@model_validator(mode="after")
def validate_bank_name(cls, values, info: ValidationInfo):
"""Match bank name against provided name (case-insensitive)"""
try:
err_msgs = []
expected = (
info.context.get("application_summary_bank_name")
if info.context
else None
)
bank_name_val = values.bank_name
if not bank_name_val:
err_msgs.append("Bank name not present")
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank name",
bank_name_val,
False,
"Bank name is not present",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank name",
bank_name_val,
True,
"Bank name is present",
]
bank_name_val_len = 0
if bank_name_val:
bank_name_val_len = len(bank_name_val)
if not bank_name_val and not (
bank_name_val_len >= 4 and bank_name_val_len <= 50
):
err_msgs.append(
"Bank name must have a length of at least 4 & at most 50"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank name",
bank_name_val_len,
False,
"Bank name does not have a length of at least 4 & at most 50",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank name",
bank_name_val_len,
True,
"Bank name has a length of at least 4 & at most 50",
]
if (
not expected
or not bank_name_val
or bank_name_val.lower() != expected.lower()
):
err_msgs.append("Bank name mismatch with provided value")
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Data Match",
f"{bank_name_val}, {expected}",
False,
"Bank name does not match with provided value",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Data Match",
f"{bank_name_val}, {expected}",
True,
"Bank name matches with provided value",
]
if err_msgs:
values.bank_name_err_msgs = ", ".join(err_msgs)
else:
values.bank_name_err_msgs = None
return values
except Exception as e:
# logger.exception(e, exc_info=True)
# return None
raise
@model_validator(mode="after")
def validate_account_number(cls, values):
"""Validate detected bank account number"""
try:
err_msgs = list()
if not values.account_number:
err_msgs.append(
"Bank account number not present. Bank account number must be present."
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank account number",
values.account_number,
False,
"Bank account number is not present.",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank account number",
values.account_number,
True,
"Bank name matches is present",
]
if not values.account_number or not re.fullmatch(
r"^\d{8}$", values.account_number
):
err_msgs.append(
"Provided account number is invalid. It must be of 8 digits length only"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank account number",
values.account_number,
False,
"Provided account number is invalid",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Bank account number",
values.account_number,
True,
"Provided account number is valid",
]
if err_msgs:
values.account_number_err_msgs = ", ".join(err_msgs)
else:
values.account_number_err_msgs = None
return values
except Exception as e:
# logger.exception(e, exc_info=True)
# return None
raise
@model_validator(mode="after")
def validate_sort_code(cls, values):
"""Validate extracted Bank Account Sort Code"""
try:
err_msgs = list()
if not values.sort_code:
err_msgs.append(
"Sort code not present. Sort number must be present.")
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Sort code",
values.sort_code,
False,
"Sort code is not present.",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Sort code",
values.sort_code,
True,
"Sort code is present.",
]
# if not values.sort_code or not re.fullmatch(r"^\d{2}-?\d{2}-?\d{2}$", values.sort_code):
if not values.sort_code or not re.fullmatch(
r"^\d{2}-\d{2}-\d{2}$", values.sort_code
):
err_msgs.append(
"Provided sort code's format is invalid. It must be of the format xx-xx-xx wherein x are digits."
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Sort code",
values.sort_code,
False,
"Sort code's format is invalid.",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Sort code",
values.sort_code,
True,
"Sort code's format is valid.",
]
if err_msgs:
values.sort_code_err_msgs = ", ".join(err_msgs)
else:
values.sort_code_err_msgs = None
return values
except Exception as e:
# logger.exception(e, exc_info=True)
# return None
raise
@model_validator(mode="after")
def validate_bank_account_statement_dates(cls, values):
try:
err_msgs = list()
statement_start_date_val = values.statement_start_date
statement_end_date_val = values.statement_end_date
if not statement_start_date_val or not statement_end_date_val:
err_msgs.append(
"Both statement start date & statement end date must be present"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Date checks",
f"{statement_start_date_val}, {statement_end_date_val}",
False,
"Both statement start date & statement end date are not present",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Date checks",
f"{statement_start_date_val}, {statement_end_date_val}",
True,
"Both statement start date & statement end date are present",
]
if statement_start_date_val and statement_end_date_val:
if (statement_end_date_val - statement_start_date_val).days < 28:
err_msgs.append(
"Account statement period's start date & end date must have a gap of at least 28 days"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Coverage",
f"{statement_start_date_val}, {statement_end_date_val}",
False,
"Account statement period's start date & end date donot have a gap of at least 28 days",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Coverage",
f"{statement_start_date_val}, {statement_end_date_val}",
True,
"Account statement period's start date & end date have a gap of at least 28 days",
]
if err_msgs:
values.account_statement_date_err_msgs = ", ".join(err_msgs)
else:
values.account_statement_date_err_msgs = None
return values
except Exception as e:
# logger.exception(e, exc_info=True)
# return None
raise
@model_validator(mode="after")
def validate_salary_credit_checks(cls, values):
try:
err_msgs = list()
statement_start_date_val = values.statement_start_date
statement_end_date_val = values.statement_end_date
first_salary_deposit_date_present_val = (
values.first_salary_deposit_date_present
)
# # is_salary_credit_present_val = values.is_salary_credit_present
# is_salary_credit_consistent_across_months_val = (
# values.is_salary_credit_consistent_across_months
# )
# if not statement_start_date_val or not statement_end_date_val:
# err_msgs.append(
# "Both statement start date & statement end date must be present"
# )
# values.validation_policy_status_df.loc[len(
# values.validation_policy_status_df)] = ["Both statement start date & statement end date must be present", f"{statement_start_date_val}, {statement_end_date_val}", False, "Both statement start date & statement end date are not present"]
# else:
# values.validation_policy_status_df.loc[len(
# values.validation_policy_status_df)] = ["Both statement start date & statement end date must be present", f"{statement_start_date_val}, {statement_end_date_val}", True, "Both statement start date & statement end date are present"]
if not first_salary_deposit_date_present_val:
err_msgs.append("At least one salary credit must be present")
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Salary deposit",
first_salary_deposit_date_present_val,
False,
"At least one salary credit is not present",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Salary deposit",
first_salary_deposit_date_present_val,
True,
"At least one salary credit is present",
]
if (
not statement_start_date_val
or not statement_end_date_val
or (statement_end_date_val < statement_start_date_val)
):
err_msgs.append(
"Statement period's end date must be after the start date"
)
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Date checks",
f"{statement_start_date_val}, {statement_end_date_val}",
False,
"Statement period's end date is not after the start date",
]
else:
values.validation_policy_status_df.loc[
len(values.validation_policy_status_df)
] = [
"Date checks",
f"{statement_start_date_val}, {statement_end_date_val}",
True,
"Statement period's end date is after the start date",
]
# # if start and end and (start.month != end.month or start.year != end.year):
# if (
# statement_start_date_val
# and statement_end_date_val
# and first_salary_deposit_date_present_val
# and (
# statement_start_date_val.month < statement_end_date_val.month
# or statement_start_date_val.year < statement_end_date_val.year
# )
# and (
# statement_end_date_val.day >= first_salary_deposit_date_present_val
# )
# ):
# if not is_salary_credit_consistent_across_months_val:
# err_msgs.append(
# "Salary credit amount across months must be consistent"
# )
if err_msgs:
values.salary_deposit_err_msgs = ", ".join(err_msgs)
else:
values.salary_deposit_err_msgs = None
return values
except Exception as e:
# logger.exception(e, exc_info=True)
# return None
raise
@computed_field
@property
def is_red_flagged(self) -> bool:
if (
self.account_statement_date_err_msgs
or self.full_name_err_msgs
or self.bank_name_err_msgs
or self.account_number_err_msgs
or self.sort_code_err_msgs
or self.salary_deposit_err_msgs
):
return True
return False
|