# IdentityLookup

Represents an identity lookup resource

## Example Usage

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

let value: IdentityLookup = {};
```

## Fields

| Field                                                                                                                                                                              | Type                                                                                                                                                                               | Required                                                                                                                                                                           | Description                                                                                                                                                                        | Example                                                                                                                                                                            |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `createTime`                                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                      | :heavy_minus_sign:                                                                                                                                                                 | Time when the identity lookup was created                                                                                                                                          | 2021-01-01T00:00:00Z                                                                                                                                                               |
| `deviceMetadata`                                                                                                                                                                   | [components.DeviceMetadata](../../models/components/devicemetadata.md)                                                                                                             | :heavy_minus_sign:                                                                                                                                                                 | End-user device metadata for fraud detection and compliance purposes This must be the metadata from the actual end-user's device, not from any intermediate proxy or client server |                                                                                                                                                                                    |
| `identification`                                                                                                                                                                   | [components.IdentityLookupIdentification](../../models/components/identitylookupidentification.md)                                                                                 | :heavy_minus_sign:                                                                                                                                                                 | Identification document for verification                                                                                                                                           | {<br/>"region_code": "US",<br/>"type": "SSN",<br/>"value": "123-45-6789"<br/>}                                                                                                     |
| `lookupResult`                                                                                                                                                                     | [components.LookupResult](../../models/components/lookupresult.md)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                 | Will be populated when `state` is `IDENTITY_FOUND` Depending on the confidence level, some fields may be missing                                                                   |                                                                                                                                                                                    |
| `name`                                                                                                                                                                             | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | The resource name of the identity lookup                                                                                                                                           | correspondents/01HPMZZM6RKMVZA1JQ63RQKJRP/identityLookups/01HEWVF4ZSNKYRP293J53ASJCJ                                                                                               |
| `phoneNumber`                                                                                                                                                                      | [components.IdentityLookupPhoneNumber](../../models/components/identitylookupphonenumber.md)                                                                                       | :heavy_minus_sign:                                                                                                                                                                 | Phone number to be used for 2FA in E.164 format                                                                                                                                    | {<br/>"e164_number": "+14155552671"<br/>}                                                                                                                                          |
| `state`                                                                                                                                                                            | [components.IdentityLookupState](../../models/components/identitylookupstate.md)                                                                                                   | :heavy_minus_sign:                                                                                                                                                                 | Current state of the identity lookup                                                                                                                                               | VERIFICATION_PENDING                                                                                                                                                               |
| `updateTime`                                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                      | :heavy_minus_sign:                                                                                                                                                                 | Time when the identity lookup was last updated                                                                                                                                     | 2021-01-01T00:00:00Z                                                                                                                                                               |
| `userConsent`                                                                                                                                                                      | *boolean*                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                 | Verify User has consented to an identity lookup                                                                                                                                    | true                                                                                                                                                                               |