Skip to main content
POST
/
virtual-accounts
/
kyc
Submit customer KYC
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/kyc \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "customer_id": "<string>",
  "tos_link": "<string>"
}

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
​
email
string<email>
required
​
customer_type
enum<string>
required
Available options:
individual,
business

Response

KYC initiated

​
customer_id
string
​
tos_link
string<uri>