Get Identity Verification Results

Retrieves the identity verification for an applicant. Returns both primary and secondary IDV results.

Path Parameters
applicationId uuid — REQUIRED The unique identifier for the application
applicantId uuid — REQUIRED The unique identifier for the applicant

Header Parameters
X-CreditApp-Creditor-ID uuid
X-CreditApp-Retailer-ID uuid

Responses
200 Identity verification results retrieved successfully. Returns primary and/or secondary IDV results. Either can be null if not submitted to this creditor. Schema — OPTIONAL primary object Identity verification results for an applicant. applicationId uuid The application identifier applicantId uuid The applicant identifier document object Government-issued document information type string — OPTIONAL Type of document (e.g., "DRIVERS_LICENSE", "PASSPORT") number string — OPTIONAL Document number country string — OPTIONAL Document issuing country code releaseYear string — OPTIONAL Year the document version was released name string — OPTIONAL Full document name issueDate date — OPTIONAL Document issue date expiryDate date — OPTIONAL Document expiry date barcode string — OPTIONAL Raw barcode data from document identity object Identity information extracted from the government-issued document firstName string — OPTIONAL First name from document middleName string — OPTIONAL Middle name from document lastName string — OPTIONAL Last name from document givenName string — OPTIONAL Given name field from document dateOfBirth date — OPTIONAL Date of birth from document address string — OPTIONAL Address from document sex string — OPTIONAL Sex/gender from document height string — OPTIONAL Height from document images object Signed URLs to IDV images frontImageUrl string — OPTIONAL Signed URL to front of document image backImageUrl string — OPTIONAL Signed URL to back of document image faceImageUrl string — OPTIONAL Signed URL to applicant's face photo identityVerificationResult string Possible values: [HIGH, MEDIUM, LOW, UNAVAILABLE, UNKNOWN] Identity verification result from the provider, potentially modified based on comparison results. identityVerificationResultStatus string — OPTIONAL Possible values: [PASSED, INCONCLUSIVE, FAILED] Simplified identity verification status derived from identityVerificationResult. PASSED: High confidence verification (HIGH) INCONCLUSIVE: Medium confidence or unavailable (MEDIUM, UNKNOWN, UNAVAILABLE) FAILED: Low confidence verification (LOW) identityVerificationReportPdfUrl string — OPTIONAL Signed URL to the generated IDV PDF report. secondary object Identity verification results for an applicant. applicationId uuid The application identifier applicantId uuid The applicant identifier document object Government-issued document information type string — OPTIONAL Type of document (e.g., "DRIVERS_LICENSE", "PASSPORT") number string — OPTIONAL Document number country string — OPTIONAL Document issuing country code releaseYear string — OPTIONAL Year the document version was released name string — OPTIONAL Full document name issueDate date — OPTIONAL Document issue date expiryDate date — OPTIONAL Document expiry date barcode string — OPTIONAL Raw barcode data from document identity object Identity information extracted from the government-issued document firstName string — OPTIONAL First name from document middleName string — OPTIONAL Middle name from document lastName string — OPTIONAL Last name from document givenName string — OPTIONAL Given name field from document dateOfBirth date — OPTIONAL Date of birth from document address string — OPTIONAL Address from document sex string — OPTIONAL Sex/gender from document height string — OPTIONAL Height from document images object Signed URLs to IDV images frontImageUrl string — OPTIONAL Signed URL to front of document image backImageUrl string — OPTIONAL Signed URL to back of document image faceImageUrl string — OPTIONAL Signed URL to applicant's face photo identityVerificationResult string Possible values: [HIGH, MEDIUM, LOW, UNAVAILABLE, UNKNOWN] Identity verification result from the provider, potentially modified based on comparison results. identityVerificationResultStatus string — OPTIONAL Possible values: [PASSED, INCONCLUSIVE, FAILED] Simplified identity verification status derived from identityVerificationResult. PASSED: High confidence verification (HIGH) INCONCLUSIVE: Medium confidence or unavailable (MEDIUM, UNKNOWN, UNAVAILABLE) FAILED: Low confidence verification (LOW) identityVerificationReportPdfUrl string — OPTIONAL Signed URL to the generated IDV PDF report.
403 Forbidden - Insufficient permissions or creditor ID mismatch
404 Not Found - No IDV has been submitted to this creditor yet Schema — OPTIONAL status integer — OPTIONAL message string — OPTIONAL