Request
[GET]
Header
| Header | Type | Description |
|---|---|---|
| AppId | string | Create an app to get your app ID on dashboard here |
| Authorization | string | Private/secret key. Use <key> not Bearer <key> |
Body Parameter
| Parameter | Type | Description | Required |
|---|---|---|---|
| first_name * | string | required | |
| last_name * | string | required | |
| address_street_1 * | string | required | |
| address_street_2 | string | optional | |
| address_city | string | Conditional: required if zipcode is not present | |
| address_state | string | Conditional: required if zipcode is not present | |
| address_zip_code | string | Conditional: not required if city and state are present | |
| identity_number_type * | string | โโSSN9โ or โSSN4โโ | required |
| identity_number * | string | required |
Sample response
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| entity | object | Contains the verification result |
| entity.id-number | number | Internal reference ID for the verification request |
| entity.results | object | Verification match details |
| entity.results.key | string | Result key code (e.g., โresult.matchโ) |
| entity.results.message | string | Human-readable result message (e.g., โID Locatedโ) |
| entity.summary-result | object | Overall verification summary |
| entity.summary-result.key | string | Summary key code (e.g., โid.successโ) |
| entity.summary-result.message | string | Final verification outcome (โPASSโ or โFAILโ) |