Skip to main content
POST
/
api
/
v1
/
mpc
/
users
/
read
{
  "read-shares": [
    "{\"user-token-share\":\"a1b2c3d4e5f6\"}",
    "{\"user-token-share\":\"share2\"}"
  ]
}

{
  "type": "job-status",
  "job-id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created"
}

​
Overview

Retrieves user data from the BOOP Network by submitting encrypted read shares for multi-party computation. This endpoint returns consent settings, vendor permissions, and user attributes.
This endpoint requires encrypted MPC shares and is typically called by authorized services, not directly by vendors.

​
Request

​
read-shares
array
required
Array of read shares for MPC computation. Each share is a serialized JSON string containing the user-token-share for the user to read.

​
Response

​
type
string
required
Will be “job-status” for async operations
​
job-id
string
required
Unique identifier for tracking the read job
​
status
string
required
Current status: “created”, “processing”, “completed”, or “failed”
{
  "read-shares": [
    "{\"user-token-share\":\"a1b2c3d4e5f6\"}",
    "{\"user-token-share\":\"share2\"}"
  ]
}

{
  "type": "job-status",
  "job-id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created"
}

​
Job Status Polling

After submitting a read request, poll the job status endpoint: 
GET /api/v1/mpc/jobs/{job-id}

​
Understanding Read Results

When the job completes successfully, the read-shares array contains hex-encoded JSON strings with:
  • consent-attributes: List of [attribute-type, palm-side] tuples
  • consent-vendors: List of consented vendor names
  • attributes-share: Array of attribute shares with type and value
  • created-at: Timestamp when user was created

​
Security Considerations

  • All shares must be properly encrypted before transmission
  • Each share should be sent to a different MPC node
  • Use TLS for all API communications
  • Never log or store raw shares

​
Rate Limits

  • 50 user reads per minute per API key
  • 500 user reads per hour per API key