Skip to main content
GET
/
users
/
verification-requests
List verification requests
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/users/verification-requests \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "count": 123,
  "limit": 123,
  "last_evaluated_key": "<string>",
  "requests": [
    {
      "request_id": "<string>",
      "user_id": "<string>",
      "beneficiary_id": "<string>",
      "transaction_id": "<string>",
      "verification_type": "bvn",
      "status": "pending",
      "requested_at": "<string>",
      "submitted_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"

Query Parameters

​
user_id
string
​
beneficiary_id
string
​
transaction_id
string
​
status
enum<string>
Available options:
pending,
submitted,
verified,
rejected,
expired
​
limit
integer
default:50
​
last_evaluated_key
string

Base64-encoded DynamoDB pagination token.

Response

Verification request list

​
count
integer
​
limit
integer
​
last_evaluated_key
string | null
​
requests
object[]