SDK-2116: Add Third Party Identity Fraud Check Result To IDV

Author: Rodion Liuborets

src/DocScan/Constants.php

@@ -10,6 +10,7 @@ class Constants
     public const SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK = 'SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK';
     public const ID_DOCUMENT_FACE_MATCH = 'ID_DOCUMENT_FACE_MATCH';
     public const THIRD_PARTY_IDENTITY = 'THIRD_PARTY_IDENTITY';
+    public const THIRD_PARTY_IDENTITY_FRAUD_1 = "THIRD_PARTY_IDENTITY_FRAUD_1";
     public const LIVENESS = 'LIVENESS';
     public const WATCHLIST_SCREENING = 'WATCHLIST_SCREENING';
     public const WATCHLIST_ADVANCED_CA = 'WATCHLIST_ADVANCED_CA';

src/DocScan/Session/Retrieve/GetSessionResult.php

@@ -233,6 +233,14 @@ public function getLivenessChecks(): array
         return $this->filterCheckByType(LivenessCheckResponse::class);
     }
 
+    /**
+     * @return ThirdPartyIdentityFraudOneCheckResponse[]
+     */
+    public function getThirdPartyIdentityFraudOneChecks(): array
+    {
+        return $this->filterCheckByType(ThirdPartyIdentityFraudOneCheckResponse::class);
+    }
+
     /**
      * @param array<string, mixed> $check
      * @return CheckResponse
@@ -259,6 +267,8 @@ private function createCheckFromArray(array $check): CheckResponse
                 return new WatchlistScreeningCheckResponse($check);
             case Constants::WATCHLIST_ADVANCED_CA:
                 return new WatchlistAdvancedCaCheckResponse($check);
+            case Constants::THIRD_PARTY_IDENTITY_FRAUD_1:
+                return new ThirdPartyIdentityFraudOneCheckResponse($check);
             default:
                 return new CheckResponse($check);
         }

src/DocScan/Session/Retrieve/ThirdPartyIdentityFraudOneCheckResponse.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Yoti\DocScan\Session\Retrieve;
+
+use Yoti\DocScan\Session\Retrieve\Contracts\ProfileCheckResponse;
+
+/**
+ *  Represents a check with a third party fraud prevention organisation
+ *
+ *  Yoti recommends that you inform your users that their data might be checked against a third party data source
+ *  as part of the fraud check.
+ */
+class ThirdPartyIdentityFraudOneCheckResponse extends ProfileCheckResponse
+{
+}

tests/DocScan/Session/Retrieve/GetSessionResultTest.php

@@ -8,6 +8,7 @@
 use Yoti\DocScan\Session\Retrieve\CheckResponse;
 use Yoti\DocScan\Session\Retrieve\GetSessionResult;
 use Yoti\DocScan\Session\Retrieve\IdentityProfileResponse;
+use Yoti\DocScan\Session\Retrieve\ThirdPartyIdentityFraudOneCheckResponse;
 use Yoti\Test\TestCase;
 use Yoti\Util\DateTime;
 
@@ -21,6 +22,7 @@ class GetSessionResultTest extends TestCase
     private const ID_DOCUMENT_TEXT_DATA_CHECK = 'ID_DOCUMENT_TEXT_DATA_CHECK';
     private const ID_DOCUMENT_COMPARISON = 'ID_DOCUMENT_COMPARISON';
     private const THIRD_PARTY_IDENTITY = 'THIRD_PARTY_IDENTITY';
+    private const THIRD_PARTY_IDENTITY_FRAUD_1 = "THIRD_PARTY_IDENTITY_FRAUD_1";
     private const WATCHLIST_SCREENING = 'WATCHLIST_SCREENING';
     private const WATCHLIST_ADVANCED_CA = 'WATCHLIST_ADVANCED_CA';
     private const SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK = 'SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK';
@@ -122,6 +124,7 @@ public function shouldParseUnknownCheck()
      * @covers ::getSupplementaryDocumentTextDataChecks
      * @covers ::getLivenessChecks
      * @covers ::getWatchlistAdvancedCaChecks
+     * @covers ::getThirdPartyIdentityFraudOneChecks
      * @covers ::createCheckFromArray
      * @covers ::filterCheckByType
      */
@@ -138,12 +141,13 @@ public function shouldFilterChecks(): void
                 ['type' => self::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK],
                 ['type' => self::LIVENESS],
                 ['type' => self::WATCHLIST_ADVANCED_CA],
+                ['type' => self::THIRD_PARTY_IDENTITY_FRAUD_1],
             ],
         ];
 
         $result = new GetSessionResult($input);
 
-        $this->assertCount(9, $result->getChecks());
+        $this->assertCount(10, $result->getChecks());
         $this->assertCount(1, $result->getAuthenticityChecks());
         $this->assertCount(1, $result->getFaceMatchChecks());
         $this->assertCount(1, $result->getTextDataChecks());
@@ -154,6 +158,7 @@ public function shouldFilterChecks(): void
         $this->assertCount(1, $result->getSupplementaryDocumentTextDataChecks());
         $this->assertCount(1, $result->getLivenessChecks());
         $this->assertCount(1, $result->getWatchlistAdvancedCaChecks());
+        $this->assertCount(1, $result->getThirdPartyIdentityFraudOneChecks());
 
         $this->assertEquals(
             self::ID_DOCUMENT_AUTHENTICITY,
@@ -195,5 +200,29 @@ public function shouldFilterChecks(): void
             self::LIVENESS,
             $result->getLivenessChecks()[0]->getType()
         );
+
+        $this->assertInstanceOf(
+            ThirdPartyIdentityFraudOneCheckResponse::class,
+            $result->getThirdPartyIdentityFraudOneChecks()[0]
+        );
+    }
+
+    /**
+     * @test
+     * @covers ::getThirdPartyIdentityFraudOneChecks
+     * @covers ::createCheckFromArray
+     * @covers ::filterCheckByType
+     */
+    public function thirdPartyIdentityFraudOneChecksShouldReturnEmptyCollectionWhenNoneOfTypeArePresent()
+    {
+        $input = [
+            'checks' => [
+                ['type' => self::ID_DOCUMENT_AUTHENTICITY],
+            ],
+        ];
+
+        $result = new GetSessionResult($input);
+
+        $this->assertCount(0, $result->getThirdPartyIdentityFraudOneChecks());
     }
 }