Skip to content

Profiles

API information

The profile resource is managed by the Profiles API.

Service URLs

Region URL
AMER https://profiles.amer.xpkit.net
APAC https://profiles.apac.xpkit.net
China https://profiles.china.xpkit.cn
EMEA https://profiles.emea.xpkit.net

OpenAPI Specification

Resource name Documentation Download
Profile View Link

Example profile

{
    "address": {
        "code": "ABC1 890",
        "city": "London",
        "country": "UK",
        "line2": "London",
        "line1": "123 New Road"
    },
    "created": "2022-12-19T13:28:12Z",
    "email": [
        "sarah.jones@abc.com",
        "sjones@abc.com"
    ],
    "first_name": "Sarah",
    "language": "en_GB",
    "last_modified": "2022-03-01T15:44:22Z",
    "last_name": "Jones",
    "qr_code": [
        "inksyf7tv2",
        "bzfh6mnex9"
    ],
    "rfid": [
        "3138020808"
    ]
}

Notes on profiles

  • The following (optional) fields should be provided as arrays: email, qr_code and rfid even if only one value is to be saved per profile. The values stored in these arrays must be unique, for example an identical RFID cannot belong to more than one profile.
  • If no data is provided for the email, qr_code and rfid fields, empty arrays will be created.
  • If you specify a language field this will be used throughout XPKit. For example if you create a notification rule in XPKit Portal to send an email (or SMS) to a profile, the visitor's language preference in their profile will be used to select the appropriate template.