Skip to main content
POST
/
users
/
notifications
/
verification-request
Send verification data request notification
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/users/notifications/verification-request \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "user_id": "<string>",
  "target_type": "beneficiary",
  "transaction_id": "<string>",
  "verification_type": "bvn",
  "triggered_by": "<string>",
  "beneficiary_id": "<string>",
  "sender_id": "<string>",
  "message": "<string>",
  "priority": "high"
}
'
{
  "message": "<string>",
  "target_type": "beneficiary",
  "verification_type": "bvn",
  "transaction_id": "<string>",
  "results": [
    {
      "target": "<string>",
      "success": true,
      "message": "<string>",
      "user_id": "<string>",
      "request_id": "<string>",
      "status": "<string>"
    }
  ],
  "all_success": 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
​
user_id
string
required

ID of the requesting user (the transaction sender).

​
target_type
enum<string>
required

Who should receive the notification. beneficiary requires beneficiary_id. sender requires sender_id. both requires both IDs.

Available options:
beneficiary,
sender,
both
​
transaction_id
string
required
​
verification_type
enum<string>
required
Available options:
bvn,
nin
​
triggered_by
string
required
​
beneficiary_id
string

Required when target_type is beneficiary or both.

​
sender_id
string

Required when target_type is sender or both.

​
message
string

Optional custom message body.

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

Response

Notification(s) sent successfully

​
message
string
​
target_type
enum<string>
Available options:
beneficiary,
sender,
both
​
verification_type
enum<string>
Available options:
bvn,
nin
​
transaction_id
string
​
results
object[]

Present when target_type is both.

​
all_success
boolean

True only when all notifications were dispatched successfully.