Skip to main content

Using the Auth API

A single POST request is needed to authenticate a user.

The /auth request returns a Customer object but with different amount of information filled out depending on the LookupType. If LookupType.NameAddressFamily is selected then the extra values returned will be returned in Meta

There are three different return types depending on the LookupType

  1. Name: Will only return the SSN and Name of the authenticated person. This has no additional lookup cost.
  2. NameAddress: Will return Name, SSN and legal address information. This has an additional lookup cost. This is the default value if no value is given for LookupType.
  3. NameAddressFamily: Returns Name, SSN, Address data, gender code, and family information. Note: Family lookup requires special permission.

Example request to authenticate a person

## Request

POST /api/Auth HTTP/1.1
Accept: application/json
Content-Type: application/json
"PhoneNumber": "8433600",
"FlowKey": "54ab65385c5b",
"LookupType": "NameAddressFamily"

## Response
"name": "Test User",
"ssn": "123456-7890",
"phoneNumber": "8433600",
"address": "Address 5",
"postalCode": "555",
"city": "Reykjavík",
"token": "f19b032a237e4fbc94f3",
"flowKey": "98ab35315c5b",
"meta": {
"ParnerSsn": "1231231245",
"FamilyNumber": "1234567890",
"GenderCode": "1",
"FamilyStatus": "3"

Examples code in different languages


$request = new HttpRequest();

'Host' => '',
'Content-Type' => 'application/json',
'Accept' => 'application/json'

"PhoneNumber": "8433600",
"FlowKey": "54ab65385c5b",
"LookupType": "Name"

try {
$response = $request->send();

echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;