User Management

Detailed reference for user profile, enrollment, token, and migration endpoints.

Endpoint Reference

POST /idp/array/users

• Description: create an IDP profile for the current user

• Authentication: XV/OpenID token with 2FA

Request body:

Field	Type	Required	Notes
firstName	string	yes
lastName	string	yes
dob	string	yes	YYYY-MM-DD
emailAddress	string	yes
address	object	yes	street, city, state, zip
phoneNumber	string	no	digits only
ssn	string	no	last 4 or full 9
version	integer	no	entitlement mapping version; defaults to 0 if omitted

version guidance:

The version field controls entitlement mapping during user creation. If omitted, the service uses migration version 0. Use 1 when you want to enroll the user with IDD standalone feature set.

Example request:

{
  "firstName": "Alex",
  "lastName": "Taylor",
  "dob": "1990-03-10",
  "emailAddress": "[email protected]",
  "phoneNumber": "2125550123",
  "ssn": "123456789",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip": "10001"
  },
  "version": 1
}

Responses on success:

• 200 OK

Example response:

{
  "userToken": "<array-user-token>",
  "expirationDate": 1757076000
}

---

GET /idp/array/users/me

• Description: read profile completeness and authentication status

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

Example response:

{
  "arrayUserId": "45ac7b00-46ab-4b89-bc72-4617b2c55340",
  "authenticated": false,
  "twoFactorEnabled": true,
  "authAttempts": 0,
  "remainingAuthAttempts": 3,
  "lastAuthAttempt": null,
  "firstNameConfigured": true,
  "lastNameConfigured": true,
  "dobConfigured": true,
  "addressConfigured": true,
  "emailConfigured": true,
  "phoneNumberConfigured": false,
  "ssnConfigured": false
}

---

PATCH /idp/array/users/me

• Description: update profile data

• Authentication: XV/OpenID token with 2FA

Request body (all optional):

• emailAddress

• phoneNumber

• ssn

• dob

• address with street, city, state, zip

Example request:

{
  "phoneNumber": "2125550199",
  "ssn": "123456789"
}

Responses on success:

• 200 OK

---

DELETE /idp/array/users/me

• Description: delete and unenroll current user

• Authentication: XV/OpenID token with 2FA

• Request body: none

Responses on success:

• 200 OK

Example response:

{
  "message": "OK"
}

---

POST /idp/array/users/me/enroll

• Description: activate products based on current entitlements

• Authentication: XV/OpenID token with 2FA

• Request body: none

Responses on success:

• 200 OK

---

POST /idp/array/users/me/token

• Description: generate or refresh Array user token

• Authentication: XV/OpenID token with 2FA

• Request body: none

Responses on success:

• 200 OK

Example response:

{
  "userToken": "<array-user-token>",
  "expirationDate": 1757076000
}

---

POST /idp/array/users/me/migration

• Description: set migration version and trigger best-effort enrollment sync

• Authentication: XV/OpenID token with 2FA

Request body:

{
  "version": 1
}

version guidance:

The version field controls entitlement mapping during user creation. Use 1 when you want to enroll the user with IDD standalone feature set.

Responses on success:

• 200 OK when the version changes

• 204 No Content when the version is unchanged