Skip to main content
GET
/
users
/
verification-requests
/
{request_id}
/
status
Get verification request status
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/users/verification-requests/{request_id}/status \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "request_id": "<string>",
  "user_id": "<string>",
  "beneficiary_id": "<string>",
  "transaction_id": "<string>",
  "verification_type": "bvn",
  "status": "pending",
  "requested_by": "<string>",
  "requested_at": "<string>",
  "submitted_at": "<string>",
  "verified_at": "<string>",
  "submitted_value": "<string>",
  "verification_result": {},
  "notes": "<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

​
request_id
string
required

Response

Verification request detail

​
request_id
string
​
user_id
string
​
beneficiary_id
string
​
transaction_id
string
​
verification_type
enum<string>
Available options:
bvn,
nin
​
status
enum<string>
Available options:
pending,
submitted,
verified,
rejected,
expired
​
requested_by
string
​
requested_at
string
​
submitted_at
string | null
​
verified_at
string | null
​
submitted_value
string | null

The actual BVN/NIN value submitted. Sensitive — treat with care.

​
verification_result
object
​
notes
string | null