Skip to main content
POST
/
users
/
register
Register a new user
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/users/register \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "fname": "<string>",
  "lname": "<string>",
  "password": "<string>",
  "date_of_birth": "1990-01-15",
  "role": "admin",
  "type": "internal-admin",
  "created_by": "<string>",
  "org_id": "<string>",
  "org_name": "<string>",
  "phone_number": "<string>",
  "address": "<string>",
  "country": "<string>",
  "id_type": "passport",
  "id_number": "<string>",
  "additional_id_type": "passport",
  "additional_id_number": "<string>",
  "org_member_role": "<string>",
  "invited_by_user_id": "<string>"
}
'
{
  "message": "User registered successfully",
  "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>"
  },
  "requires_confirmation": true
}

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"

Body

application/json
​
email
string<email>
required
​
fname
string
required
​
lname
string
required
​
password
string<password>
required
​
date_of_birth
string
Example:

"1990-01-15"

​
role
enum<string>
Available options:
admin,
super-admin,
retail,
freelancer,
org-staff
​
type
enum<string>
Available options:
internal-admin,
org-admin,
merchant,
user,
staff
​
created_by
string
​
org_id
string

Existing org to register the user into.

​
org_name
string

If provided (and org_id is absent), a new organization is created with this name before user registration.

​
phone_number
string
​
address
string
​
country
string
​
id_type
enum<string>
Available options:
passport,
drivers_license,
national_id,
other
​
id_number
string
​
additional_id_type
enum<string>
Available options:
passport,
drivers_license,
national_id,
other
​
additional_id_number
string
​
org_member_role
string

Role for the user within the org (used when adding org member).

​
invited_by_user_id
string

Response

User registered

​
message
string
Example:

"User registered successfully"

​
user
object
​
requires_confirmation
boolean

True if Cognito email confirmation is needed.