Privicore
  1. Profile
Privicore
  • Privicore API
  • Utility
    • Utility
    • Check server health
      GET
    • Request command id status
      GET
  • Profile
    • Profile Model and Authentication Workflow
    • Register new profile
      POST
    • Authenticate
      POST
    • Retrieve profile id
      GET
    • Change password
      POST
    • Generate qr token for authorization
      POST
    • Reauthorize authorization token
      POST
    • Revoke authorization token
      POST
    • Retrieve token expiry
      POST
  • OAuth Application
    • OAuth Application Management
    • Register OAuth Application
      POST
    • Retrieve OAuth app configuration
      POST
    • Request OAuth app authorization code
      GET
    • Retrieve OAuth app authorization code
      POST
    • Obtain OAuth app access token
      POST
    • OAuth application list
      GET
    • Retrieve OAuth application scope
      GET
    • Refresh OAuth app access token
      POST
  • Public key
    • Public and Private Key Management
    • Generate your private and public keys
      GET
    • Register public key
      POST
    • Retrieve public key
      GET
    • Retrieve CAB public key
      GET
  • Data Token
    • Data Token Management
    • Reserve token space
    • Retrieve temporary data token
    • Exchange data for token
    • Upstream file via stream auth
    • Request data via token
    • Download data
    • Configure information security risk meta
    • Configure file meta
    • List data tokens
    • Update data token
    • Delete data
    • Get data token transaction count statistics.
  • Device
    • Request unique identifier (i.e. Register new device)
    • Retrieve unique identifier
    • Retrieve profile devices
    • Configure device meta
    • Approve device
    • Reject device
    • Retrieve device configuration
    • Remove device
  • Storage
    • Register storage device
    • List storage devices
    • Synchronize device
    • Remove storage
  • Verified authenticator
    • Register authenticator
    • List verified authenticators
    • Retrieve voting strategy
    • Set quorum size
    • Set quorum strategy
    • Set voting time limit
    • Set maximum voting attempts
    • Remove authenticator
    • Register voting configuration
    • Update voting configuration
    • List voting configurations
    • Retrieve voting configuration
  • Policy
    • List policy templates
    • Register policy
    • List active policies
    • List inactive policies
    • Activate policy
    • Deactivate policy
    • Delete policy
    • List registered policies
    • Retrieve registered policy
  • Directory
    • Register Directory
    • Retrieve owned Directories
    • Retrieve assigned directories
    • Retrieve Directory
    • Create Directory User
    • Update user information
    • Invite Profile
    • Set profile password
    • List Directory Invites
    • Process Invitation
    • Retrieve directory profile
    • List directory users
    • Directory profiles info
    • Create profile device
    • Add storage device to profile
    • List directory devices
    • Create directory voting pool
    • Store directory meta information
  • Voting
    • Create voting
    • Check pool status
  • Schemas
    • Response
      • CommandAccepted
      • Unauthorized
      • ValidationErrors
    • Schemas
    • profileId
    • deviceIdentifier
    • directoryId
    • directoryName
    • directoryShortName
    • givenName
    • familyName
    • createdAt
    • meta
  1. Profile

Register new profile

POST
/profile/register-profile

Overview#

The profile registration API uses an asynchronous pattern. When you register a new profile, you receive an identifier to track the request status rather than an immediate success or failure response.

Registration Process#

1.
Register Profile
Endpoint: POST /profile/register-profile
Submit a username and password to initiate profile registration.
The API performs basic validation immediately. If validation fails, you'll receive an error response. However, business logic validation occurs asynchronously after the initial response.
2.
Check Registration Status
Endpoint: GET /request-status/{identifier}
Use the identifier from the registration response to check the processing status.

Implementation Flow#

1.
Client calls register endpoint
2.
Client receives identifier
3.
Client polls status endpoint using identifier
4.
Client checks status

Best Practices#

Poll the status endpoint at reasonable intervals (e.g., every 2-3 seconds)
Implement a timeout mechanism for status checks
Handle all possible status values in your client code
Store the identifier immediately after registration for status tracking
image.png

Check command status#

[
   "profile.profile_registered"
]

Request

Body Params application/x-www-form-urlencoded

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.privicore.com:9009/profile/register-profile' \
--data-urlencode 'username=' \
--data-urlencode 'password='

Responses

🟢202Success
application/json
Command accepted.
Use utility endpoint /request-status/{commandId} to retrieve command id status.
Upon obtaining authorization token in next request (/profile/authenticate), subscribe to your profile channel on DPT CAB websocket server via profile authorization token and receive command status messages more conveniently in real time.
Headers

Body

Example
[
    "string"
]
🟠422422
Modified at 2025-12-02 11:17:39
Previous
Profile Model and Authentication Workflow
Next
Authenticate
Built with