Skip to main content
POST
/
users
/
notifications
/
kyc
Send KYC notification
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/users/notifications/kyc \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "user_id": "<string>",
  "notification_type": "kyc_update_required",
  "triggered_by": "<string>",
  "message": "<string>",
  "priority": "medium"
}
'
{
  "message": "KYC notification sent successfully",
  "user_id": "<string>",
  "notification_type": "<string>",
  "priority": "<string>",
  "status": "sent",
  "title": "<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"

Body

application/json
​
user_id
string
required
​
notification_type
enum<string>
required
Available options:
kyc_update_required,
kyc_documents_needed,
kyc_review_pending,
kyc_approved,
kyc_rejected
​
triggered_by
string
required

Identifier of the actor triggering the notification (e.g. admin, a user ID).

​
message
string

Optional custom message body. Defaults to a type-specific template.

​
priority
enum<string>
default:medium
Available options:
low,
medium,
high,
urgent

Response

Notification sent

​
message
string
Example:

"KYC notification sent successfully"

​
user_id
string
​
notification_type
string
​
priority
string
​
status
string
Example:

"sent"

​
title
string