Creates a new device, sending device data in the request body.

Recommended values for instrument_type include: account, crypto_address, digital_wallet, credit_card, debit_card, gift_card, voucher, check.

If the /devices/create API is called for an device that already exists in our system (i.e. has an existing device_id, it is treated it as an upsert and an update on the existing device is performed. The response to the request will then contain the entry previously_existed: true.

Note that Unit21 selectively ignores upserts if the request is identical to a previous request. The response to any isgnored upsert will contain the field ignored: true.

The response will consist of the following fields:

FieldTypeDescription
device_idStringUnique identifier of the device on your platform
unit21_idStringInternal ID of the device within Unit21's system
previously_existedBooleanIf device (with the same device_id) already exists

Updates to an device's device_id are not allowed.

You can also batch upload devices to devices/create.

Language
Authentication
Header
URL
Click Try It! to start a request and see the response here!