Fetch User Identity
POST {{baseUrl}}/user-identities
This API will provide information about an individual user with one of the following: - Phone Number and Last 4 Digits of SSN. - Phone Number and National ID. - Phone Number and Date of Birth.
Request Body
{"countryCode"=>"US", "phoneNumber"=>"19999999999", "optedInConsentStatus"=>true, "scopedFields"=>["firstName", "lastName", "emailAddress", "dob", "nationalId", "address"], "dob"=>"1984-01-15", "last4ssn"=>"1234", "nationalId"=>"123456789", "performEligibilityCheck"=>false}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Encrypted-Payload | boolean | Whether the request payload is encrypted with the Encyption Key generated from the Developer Zone Portal. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"transactionId":"4e854df5-8c8c-4e9b-ba63-b43d03903427","scopedFields":{"firstName":"John","lastName":"Doe","dob":"19810627","nationalId":123456789},"address":{"address":"123 Main St","extendedAddress":"Apt. 202","city":"San Francisco","region":"CA","postalCode":94015},"emailAddress":"abc@def.com","addresses":{"address":"123 Main St","extendedAddress":"Apt. 202","city":"San Francisco","region":"CA","postalCode":94015}}