---
title: Register a Device
slug: epmm/v1web-service-api-guide/register-a-device
createdAt: 2026-11-03T13:31:48.174Z
---

This API registers a device with Ivanti EPMM. Registering or enrolling a device designates it for management in Ivanti EPMM.  The action of registering a device accomplishes the following:

- Activates a user associated with the device.
- Makes the device known to the Ivanti EPMM system.
- Downloads the Ivanti EPMM Client to the device
- Completes an initial scan of the device and synchronizes it to Ivanti EPMM.

:::hint{type="info"}
You can use this API with ServiceNow.
:::

**Examples**:

```javascript
https://<Ivanti EPMM>/api/v1/dm/register?phoneNumber=4155551212&userId=jdoe&platform=A&userFirstName=Joe&userLastName=Doe&userEmailAddress=jdoe@Ivanti.com&notifyUser=True&notifyuserbysms=True&countrycode=1&operator=Verizon
```

Notice in the following example that if the deviceType is PDA, then the phoneNumber value can be PDA:

```javascript
https://<Ivanti EPMM>/api/v1/dm/register?phoneNumber=PDA&deviceType=PDA&userId=miadmin&userFirstName=Jane&userLastName=Doe&userEmailAddress=jdoe@mi.com&countrycode=33&importUserFromLdap=False&notifyUser=True&notifyuserbysms=True&platform=I
```

| URI:<br />https\:///api/v1/dm/register/                                    | Register a device.                                                                                                                                                                                                                                                                                                                  |
| -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Http Method:                                                               | PUT                                                                                                                                                                                                                                                                                                                                 |
| Format:                                                                    | xml, json                                                                                                                                                                                                                                                                                                                           |
| Request:                                                                   |                                                                                                                                                                                                                                                                                                                                     |
| phoneNumber                                                                | Required for all device types except for PDA. If the device type is PDA, then you can enter PDA as the phone number value. This may improve performance over supplying a bogus phone number.                                                                                                                                        |
| userId                                                                     | Required.                                                                                                                                                                                                                                                                                                                           |
| operator                                                                   | String indicating operator.  This field will be updated after registration if Ivanti EPMM can find the operator based on the phoneNumber entry.                                                                                                                                                                                     |
| isEmployeeOwned                                                            | True indicates the device is owned by the employee.<br />False indicates it is owned by the company.  Default is false.                                                                                                                                                                                                             |
| platform                                                                   | Required. Platform or operating system of the device.<br />Valid values:<br />A- Android<br />I – iOS<br />E – Windows<br />M – Windows Phone devices (WP8, WP8.1)<br />L- Mac OS X                                                                                                                                                 |
| deviceType                                                                 | Device type can be a phone or PDA. <br />Valid values : Phone, PDA<br />If device is a PDA, then phone number is optional and you can enter PDA as the phone number value, too.                                                                                                                                                     |
| importUserFromLdap                                                         | True – import the matching user from LDAP.<br />False –create a local user.<br /><br />If a local user does not exist with the input userid, then a new local user is created. For local users, first name, last name, and email address are required.<br /><br />Ivanti EPMM sets the password for a new local user to the userid. |
| userFirstName                                                              | Required for local user. User’s first name.                                                                                                                                                                                                                                                                                         |
| userLastName                                                               | Required for local user. User’s last name.                                                                                                                                                                                                                                                                                          |
| userEmailAddress                                                           | Required for local user. User’s email address.                                                                                                                                                                                                                                                                                      |
| notifyUser                                                                 | True indicates user should be notified of registration by email. False indicates user should not be notified.                                                                                                                                                                                                                       |
| notifyuserbysms                                                            | True indicates user should be notified of registration by SMS. False indicates user should not be notified by SMS.                                                                                                                                                                                                                  |
| countryCode                                                                | Required. Country code of the operator.                                                                                                                                                                                                                                                                                             |
|                                                                            |                                                                                                                                                                                                                                                                                                                                     |
| Response Status Code:                                                      |                                                                                                                                                                                                                                                                                                                                     |
| ‘404 – No Data Found’                                                      | There is no data.                                                                                                                                                                                                                                                                                                                   |
| ‘200 – OK’                                                                 | Data is present and the response is returned.                                                                                                                                                                                                                                                                                       |
| Response:                                                                  |                                                                                                                                                                                                                                                                                                                                     |
| \<deviceManagementWebServiceResponse>                                      |                                                                                                                                                                                                                                                                                                                                     |
| \<phoneNumber>14085551212\</phoneNumber>                                   | Phone number registered.                                                                                                                                                                                                                                                                                                            |
| \<registration>                                                            |                                                                                                                                                                                                                                                                                                                                     |
| \<messages/>                                                               |                                                                                                                                                                                                                                                                                                                                     |
| \<deviceUuid>caba40e7-f56b-44aa-ac70-79e32e91adf8\</deviceUuid>            | Alpha-numeric string that uniquely identifies the device.                                                                                                                                                                                                                                                                           |
| \<messages/>                                                               | Status Message.<br />Success is shown if the method execution is successful.<br />A descriptive error message is shown if the method execution failed.                                                                                                                                                                              |
| \<status>SUCCESS\</status>                                                 | See “[Status and statusCode values](docId\:xVPydpQ15KAOMBsuI5Iwg)”.                                                                                                                                                                                                                                                                 |
| \<passcode>63460\</passcode>                                               | 5-digit numeric passcode needed during registration validation.  If the passcode is not applicable for the operating system, it will be empty.                                                                                                                                                                                      |
| \<passcodeTTL>120\</passcodeTTL>                                           | Number of hours the passcode is valid.                                                                                                                                                                                                                                                                                              |
| \<registrationUrl>http\://app16.Ivanti.com:8080/v/75b13\</registrationUrl> | URL provided to the user.  User enters a passcode to verify the device registration and the client begins to download.                                                                                                                                                                                                              |
| \</registration>                                                           |                                                                                                                                                                                                                                                                                                                                     |
| \</deviceManagementWebServiceResponse>                                     |                                                                                                                                                                                                                                                                                                                                     |
|                                                                            |                                                                                                                                                                                                                                                                                                                                     |

