NCR Voyix

NCR Provisioning API

Platform user creation and user profile management.

GitHub OpenAPI

Operations 3

POST /provisioning/users NCR Voyix Create User #
PUT /provisioning/users NCR Voyix Update Current User #
GET /provisioning/user-profiles NCR Voyix Get Current User Profile #

Documentation

📖
Documentation
https://developer.ncrvoyix.com/
📖
GettingStarted
https://developer.ncrvoyix.com/portals/dev-portal/help-center/topics?topic=All+New+Users+Start+Here

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ncr/refs/heads/main/openapi/ncr-provisioning-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/NCRVoyix-Corporation/ncr-retail-demo
💻
CodeExamples
https://github.com/NCRVoyix-Corporation/sample-app-burgers
💻
CodeExamples
https://github.com/NCRVoyix-Corporation/ncr-bsp-hmac

Other Resources

🔗
Postman
https://raw.githubusercontent.com/api-evangelist/ncr/refs/heads/main/postman/ncr-bsp-hmac-examples.postman_collection.json
🔗
APIExplorer
https://developer.ncrvoyix.com/portals/dev-portal/api-explorer

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ncr-provisioning-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ncr-provisioning-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NCR Voyix Commerce Platform Provisioning API
  description: REST APIs for the NCR Voyix Commerce Platform (Business Services Platform), the API-based cloud architecture that powers NCR Voyix unified-commerce solutions for retailers and restaurants.
  version: '1.0'
  contact:
    name: NCR Voyix Developer Experience
    url: https://developer.ncrvoyix.com/
  license:
    name: Proprietary
    url: https://www.ncrvoyix.com/
  x-generated-from: documentation
  x-last-validated: '2026-06-02'
servers:
- url: https://api.ncr.com
  description: Production (Business Services Platform)
- url: https://gateway-staging.ncrcloud.com
  description: Staging
security:
- hmacAccessKey: []
tags:
- name: Provisioning
  description: Platform user creation and user profile management.
paths:
  /provisioning/users:
    post:
      tags:
      - Provisioning
      summary: NCR Voyix Create User
      description: Create a new platform user within the organization.
      operationId: createUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserInput'
            examples:
              CreateUserRequestExample:
                summary: Default createUser request
                x-microcks-default: true
                value:
                  username: jsmith
                  email: jsmith@example.com
                  firstName: Downtown Store
                  lastName: Downtown Store
      responses:
        '201':
          description: The created user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                CreateUser201Example:
                  summary: Default createUser 201 response
                  x-microcks-default: true
                  value:
                    username: jsmith
                    email: jsmith@example.com
                    firstName: Downtown Store
                    lastName: Downtown Store
                    id: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - Provisioning
      summary: NCR Voyix Update Current User
      description: Update the currently authenticated platform user.
      operationId: updateCurrentUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserInput'
            examples:
              UpdateCurrentUserRequestExample:
                summary: Default updateCurrentUser request
                x-microcks-default: true
                value:
                  username: jsmith
                  email: jsmith@example.com
                  firstName: Downtown Store
                  lastName: Downtown Store
      responses:
        '200':
          description: The updated user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                UpdateCurrentUser200Example:
                  summary: Default updateCurrentUser 200 response
                  x-microcks-default: true
                  value:
                    username: jsmith
                    email: jsmith@example.com
                    firstName: Downtown Store
                    lastName: Downtown Store
                    id: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /provisioning/user-profiles:
    get:
      tags:
      - Provisioning
      summary: NCR Voyix Get Current User Profile
      description: Retrieve the profile data for the currently authenticated user.
      operationId: getCurrentUserProfile
      responses:
        '200':
          description: The current user profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
              examples:
                GetCurrentUserProfile200Example:
                  summary: Default getCurrentUserProfile 200 response
                  x-microcks-default: true
                  value:
                    username: jsmith
                    email: jsmith@example.com
                    firstName: Downtown Store
                    lastName: Downtown Store
                    organization: example
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UserInput:
      type: object
      properties:
        username:
          type: string
          example: jsmith
        email:
          type: string
          format: email
          example: jsmith@example.com
        firstName:
          type: string
          example: Downtown Store
        lastName:
          type: string
          example: Downtown Store
      required:
      - username
    UserProfile:
      type: object
      properties:
        username:
          type: string
          example: jsmith
        email:
          type: string
          format: email
          example: jsmith@example.com
        firstName:
          type: string
          example: Downtown Store
        lastName:
          type: string
          example: Downtown Store
        organization:
          type: string
          example: example
    User:
      allOf:
      - $ref: '#/components/schemas/UserInput'
      - type: object
        properties:
          id:
            type: string
  securitySchemes:
    hmacAccessKey:
      type: apiKey
      in: header
      name: Authorization
      description: AccessKey (HMAC) authentication. The Authorization header carries "AccessKey {sharedKey}:{signature}", where the signature is a Base64 SHA-512 HMAC computed over the HTTP method, encoded request path and query string, Content-Type, optional Content-MD5, optional nep-application-key, and optional nep-correlation-id, keyed by the secret key concatenated with the ISO-8601 request date. A Date header must accompany the request. Access keys consist of a shared key and a secret key issued by NCR Voyix. See the ncr-bsp-hmac repository for reference implementations in Python, JavaScript, Java, Kotlin, Go, Dart, .NET, and PowerShell.