# CustomerIdentificationResult

Result from a customer identification check

## Example Usage

```typescript
import { CustomerIdentificationResult } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: CustomerIdentificationResult = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                           | Example                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `birthDateVerified`                                                                                                                                                                                                                                                                                                                                                                                                   | [components.BirthDateVerified](../../models/components/birthdateverified.md)                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the customer birth date was verified                                                                                                                                                                                                                                                                                                                                                                   | UNVERIFIED                                                                                                                                                                                                                                                                                                                                                                                                            |
| `completed`                                                                                                                                                                                                                                                                                                                                                                                                           | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the result is completed Must be true to be linked to an Investigation or used to Create/Update an LegalNaturalPerson                                                                                                                                                                                                                                                                                   | true                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `documentAuthenticityVerified`                                                                                                                                                                                                                                                                                                                                                                                        | [components.DocumentAuthenticityVerified](../../models/components/documentauthenticityverified.md)                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the document authenticity is verified or not Will be NOT_IN_SCOPE if the check being done is not documentary                                                                                                                                                                                                                                                                                           | INCONCLUSIVE                                                                                                                                                                                                                                                                                                                                                                                                          |
| `documentExpiryStatus`                                                                                                                                                                                                                                                                                                                                                                                                | [components.DocumentExpiryStatus](../../models/components/documentexpirystatus.md)                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the document expiry was verified This is only in scope for document verification checks If document is expired this will be set to EXPIRED                                                                                                                                                                                                                                                             | UNEXPIRED                                                                                                                                                                                                                                                                                                                                                                                                             |
| `documentVerificationIds`                                                                                                                                                                                                                                                                                                                                                                                             | *string*[]                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | One or more ULIDs from the documents api of the image(s) of the document that relates to the identification check for a DOCUMENTARY check, these will be the images provided in the session                                                                                                                                                                                                                           | 0f01ae1f-d24c-4171-8f3f-c0b820bf3044                                                                                                                                                                                                                                                                                                                                                                                  |
| `documentarySessionUri`                                                                                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | The URI to complete documentary session Will be populated if the CheckType is DOCUMENTARY                                                                                                                                                                                                                                                                                                                             | https://example.com/                                                                                                                                                                                                                                                                                                                                                                                                  |
| `emailVerified`                                                                                                                                                                                                                                                                                                                                                                                                       | [components.EmailVerified](../../models/components/emailverified.md)                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the customer email was verified                                                                                                                                                                                                                                                                                                                                                                        | NOT_IN_SCOPE                                                                                                                                                                                                                                                                                                                                                                                                          |
| `expired`                                                                                                                                                                                                                                                                                                                                                                                                             | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the result is expired An expired result will cause all `VerificationState`'s to be `UNVERIFIED`, the `ExpirationState` will be `EXPIRED` Will always be `false` for synchronous checks such as `DATABASE` Will be `true` when an asynchronous check such as `DOCUMENTARY` hasn't been completed within the timeframe If `true` the `completed` field will be `false` since a check was never completed | false                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `externalVendor`                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | The name of the external vendor                                                                                                                                                                                                                                                                                                                                                                                       | EQUIFAX                                                                                                                                                                                                                                                                                                                                                                                                               |
| `externalVendorId`                                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | The id relating to the external vendor                                                                                                                                                                                                                                                                                                                                                                                | 0f01ae1fd24c41718f3fc0b820bf3044                                                                                                                                                                                                                                                                                                                                                                                      |
| `identificationNumberVerified`                                                                                                                                                                                                                                                                                                                                                                                        | [components.IdentificationNumberVerified](../../models/components/identificationnumberverified.md)                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the customer identification number was verified                                                                                                                                                                                                                                                                                                                                                        | VERIFIED                                                                                                                                                                                                                                                                                                                                                                                                              |
| `identityReportedDeceased`                                                                                                                                                                                                                                                                                                                                                                                            | [components.IdentityReportedDeceased](../../models/components/identityreporteddeceased.md)                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the identity has been reported as deceased This is determined by parsing the vendor response for deceased indicators from the SSA Death Master File Equifax-specific indicators: reason codes "90" (SSN Death Indicator) or "SQ" (SSN reported as deceased) null/unset = not checked or unable to determine, false = checked and not deceased, true = deceased                                         | NOT_DECEASED                                                                                                                                                                                                                                                                                                                                                                                                          |
| `identityVerificationTypes`                                                                                                                                                                                                                                                                                                                                                                                           | [components.IdentityVerificationTypes](../../models/components/identityverificationtypes.md)[]                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Describes the type(s) of Identity Verification that was performed                                                                                                                                                                                                                                                                                                                                                     | DATABASE                                                                                                                                                                                                                                                                                                                                                                                                              |
| `legalAddressVerified`                                                                                                                                                                                                                                                                                                                                                                                                | [components.LegalAddressVerified](../../models/components/legaladdressverified.md)                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the customer legal address was verified                                                                                                                                                                                                                                                                                                                                                                | VERIFIED                                                                                                                                                                                                                                                                                                                                                                                                              |
| `nameVerified`                                                                                                                                                                                                                                                                                                                                                                                                        | [components.NameVerified](../../models/components/nameverified.md)                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Presents verified results e.g. if name or birth date have been verified                                                                                                                                                                                                                                                                                                                                               | VERIFIED                                                                                                                                                                                                                                                                                                                                                                                                              |
| `phoneNumberVerified`                                                                                                                                                                                                                                                                                                                                                                                                 | [components.PhoneNumberVerified](../../models/components/phonenumberverified.md)                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the customer phone number was verified                                                                                                                                                                                                                                                                                                                                                                 | VERIFIED                                                                                                                                                                                                                                                                                                                                                                                                              |
| `rawVendorResult`                                                                                                                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Raw vendor result will return full json response from vendor if view is set to FULL                                                                                                                                                                                                                                                                                                                                   | {"field":"value"}                                                                                                                                                                                                                                                                                                                                                                                                     |
| `selfieVerified`                                                                                                                                                                                                                                                                                                                                                                                                      | [components.SelfieVerified](../../models/components/selfieverified.md)                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                    | Whether or not the customer photo identification was verified Will be NOT_IN_SCOPE if the check being done is not selfie                                                                                                                                                                                                                                                                                              | VERIFIED                                                                                                                                                                                                                                                                                                                                                                                                              |