13.08.25 | Connect | Release 3.60.1

Valid Document Type ID Validation

Our team have been working hard this year to bring yo

Highlighting mismatches in results 

To help you stay on top of documents discrepancies, new alerts will be introduced in the Client Portal when an uploaded document does not match the selected document type and isn't valid for the journey configuration. In some rare cases, like when upload attempts are exceeded, users may still submit an incorrect document. Within the breakdown of the IDV check results we have added an additional check item called 'Valid Document Type' which will show the following results:

• Pass - The document provided is a valid configured option
• Fail - The document provided is not a valid configured option
• Not performed - The document was provided prior to us implementing this change 

When an individual selects an identity document type (e.g., passport) but attempts to capture a different document (e.g., driving licence), they will now be promoted to either:

• Upload the correct document type, or
• Go back and select a valid alternative from the list

This aims to reduce confusion, errors and improve check success rates.

What's changing for API clients?

When the uploaded document does not match the selection and is not a valid configured required document type - but does manage to be submitted - and is flagged as a mismatch we will highlight this in the API:

• API responses will include a document_type_mismatch flag when applicable
• A descriptive error message will be included detailing the mismatch
• The API response will remain consistent with schema expectations, with clear documentation

Endpoint affected:

• /api/v2/ci/entities/{entityId}/idv-entries
• /api/v2/ci/entities/{entityId}/idv-entries/{entryId} 

Once updated in the IDV entry itself, any endpoint that returns the IDV entry will include the new IDV entry object where applicable such as

• /api/v2/ci/processes/{processId}/details

• /api/v2/ci/entities/{entityId}/summary

• /api/v2/ci/entities/{entityId}/active-checks