Customer

Get authenticated customer profile

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/customer

Retrieves comprehensive customer information by validating and enriching the authentication token claims.

Required scopes

This endpoint requires the following scopes:

Authorizations

neo-customer

AuthorizationstringRequired

a JWT token describing the customer

Path parameters

tenantIdstringRequired

Responses

200

Authenticated customer profile returned.

text/plainapplication/jsontext/json

Other propertiesanyOptional

401

Caller not authenticated as customer.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/{tenantId}/customer

HTTPcURLJavaScriptPython

GET /api/{tenantId}/customer HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create or update a customer account

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/customer

Creates a new customer account or updates an existing one with provided information. Supports optional flow execution (e.g., preregistration) and multi-factor authentication challenges.

Account Modification

• Creates account if customer does not exist

• Updates existing customer data

• Validates and enriches account data (e.g., deriving location from postal code)

• Fills missing fields with defaults or derived values

Flow Execution

When a flow name is specified:

1. Account is created/updated

2. Named flow is executed (e.g., "preregistration", "activation")

3. Additional security challenges may be issued

When flow is omitted:

1. Account data is validated

2. Fields are enriched and filled

3. No additional processing occurs

Authorization

No explicit authorization required; customer context derived from account identifier.

Path parameters

tenantIdstringRequired

Query parameters

flowstringOptional

Optional flow name to execute after account creation (e.g., "preregistration"). When empty, data is validated and filled without additional processing

Body

application/jsontext/jsonapplication/*+json

Other propertiesanyOptional

Responses

200

Account created or updated.

text/plainapplication/jsontext/json

Other propertiesanyOptional

202

Challenge issued for additional verification.

401

Caller not authorized to create or update the account.

text/plainapplication/jsontext/json

412

Validation failed for provided account data.

text/plainapplication/jsontext/json

500

Unexpected server error.

post

/api/{tenantId}/customer

HTTPcURLJavaScriptPython

POST /api/{tenantId}/customer HTTP/1.1
Host: app.neostore.cloud
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

application/jsontext/jsonapplication/*+json

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Authenticate customer and generate JWT token

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/customer/authenticate

Authenticates a customer using a specified identity provider and returns a JWT token for subsequent API calls.

Supported Providers

• Social Login: Facebook, Apple, Google, Line, etc.

• One-Time Password (OTP): SMS, email, or other delivery methods

• Custom Providers: Tenant-specific authentication mechanisms

Authentication Flow

1. Client sends provider name and provider-specific authentication data

2. System validates credentials with the specified provider

3. Provider returns claims (identity attributes)

4. System generates JWT token with 24-hour validity

5. Token includes provider identifier for auditing

Token Usage

The returned JWT token should be included in subsequent API requests using the Authorization: Bearer <token> header.

Path parameters

tenantIdstringRequired

Query parameters

providerstringOptional

Provider used to authenticate the user.

Body

application/jsontext/jsonapplication/*+json

anyOptional

Responses

200

Authentication succeeded and token returned.

text/plainapplication/jsontext/json

stringOptional

400

Request is missing provider or contains malformed data.

text/plainapplication/jsontext/json

422

Invalid authentication data for the specified provider.

text/plainapplication/jsontext/json

500

Unexpected server error.

post

/api/{tenantId}/customer/authenticate

HTTPcURLJavaScriptPython

POST /api/{tenantId}/customer/authenticate HTTP/1.1
Host: app.neostore.cloud
Content-Type: application/json
Accept: */*

application/jsontext/jsonapplication/*+json

text