Add a member

Integration This method allows registering a new Member as an Admin.

post

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

Body

Responses

200

Return registered member id and identifiers.

application/json

customerIdstring · uuidOptional

Registered member identity

Example: 00000000-0000-0000-0000-000000000000

emailstringOptional

Registered member email

phonestring · nullableOptional

Registered member phone

loyaltyCardNumberstring · nullableOptional

Registered member loyalty card number

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member

POST /api/{storeCode}/member HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 700

{
  "customer": {
    "referrerToken": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "loyaltyCardNumber": "text",
    "birthDate": "2026-01-01",
    "registeredAt": "2026-01-01T00:00:00.000Z",
    "address": {
      "street": "text",
      "address1": "text",
      "address2": "text",
      "postal": "text",
      "city": "text",
      "province": "text",
      "country": "text"
    },
    "company": {
      "name": "text",
      "nip": "text"
    },
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "agreement1": true,
    "agreement2": true,
    "agreement3": true,
    "levelId": "123e4567-e89b-12d3-a456-426614174000",
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "customFieldsData": [
      {
        "customFieldSchemaId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "text"
      }
    ],
    "customFields": {
      "driving": {
        "score": 90
      }
    }
  }
}

{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "email": "text",
  "phone": "text",
  "loyaltyCardNumber": "text"
}