Skip to main content
PUT
/
users
/
{user_id}
/
kyc
Update KYC status
curl --request PUT \
  --url https://prod-api.pcxpay.com/v1/users/{user_id}/kyc \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "kyc_session_id": "<string>",
  "kyc_status": "<string>"
}
'
{
  "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
​
kyc_session_id
string
required
​
kyc_status
string
required

Raw status string returned by the KYC provider.

Response

KYC status updated

​
user_id
string
​
email
string<email>
​
fname
string
​
lname
string
​
date_of_birth
string | null
​
cognito_username
string
​
bridge_customer_id
string | null
​
kyc_submitted_at
string | null

ISO 8601 datetime.

​
kyc_approved_at
string | null

ISO 8601 datetime.

​
kyc_failure_reason
string | null
​
role
enum<string>
Available options:
admin,
super-admin,
retail,
freelancer,
org-staff
​
status
enum<string>
Available options:
active,
rejected,
not_verified,
pending_verification,
pending,
sandbox,
inactive
​
type
enum<string>
Available options:
internal-admin,
org-admin,
merchant,
user,
staff
​
created_by
string
​
org_id
string | null
​
org_ids
string[]
​
phone_number
string | null
​
address
string | null
​
country
string | null
​
id_type
enum<string>
Available options:
passport,
drivers_license,
national_id,
other
​
id_number
string | null
​
additional_id_type
enum<string>
Available options:
passport,
drivers_license,
national_id,
other
​
additional_id_number
string | null
​
kyc_session_id
string | null
​
kyc_status
string | null

Raw KYC status string from the provider.

​
created_at
string

ISO 8601 datetime.

​
updated_at
string

ISO 8601 datetime.