Skip to main content
PUT
/
users
/
{user_id}
/
activate
Admin status change
curl --request PUT \
  --url https://prod-api.pcxpay.com/v1/users/{user_id}/activate \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "status": "active",
  "reason": "<string>"
}
'
{
  "message": "<string>",
  "user": {
    "user_id": "<string>",
    "email": "jsmith@example.com",
    "fname": "<string>",
    "lname": "<string>",
    "date_of_birth": "<string>",
    "cognito_username": "<string>",
    "bridge_customer_id": "<string>",
    "kyc_submitted_at": "<string>",
    "kyc_approved_at": "<string>",
    "kyc_failure_reason": "<string>",
    "role": "admin",
    "status": "active",
    "type": "internal-admin",
    "created_by": "<string>",
    "org_id": "<string>",
    "org_ids": [
      "<string>"
    ],
    "phone_number": "<string>",
    "address": "<string>",
    "country": "<string>",
    "id_type": "passport",
    "id_number": "<string>",
    "additional_id_type": "passport",
    "additional_id_number": "<string>",
    "kyc_session_id": "<string>",
    "kyc_status": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

​
user_id
string
required

Body

application/json
​
status
enum<string>
required
Available options:
active,
pending_verification,
rejected,
not_verified
​
reason
string

Response

Status changed

​
message
string
​
user
object