Skip to main content
POST
/
organizations
/
{org_id}
/
bridge-kyb
Initiate Bridge KYB for an organization
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/organizations/{org_id}/bridge-kyb \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "bridge_customer_id": "<string>",
    "tos_link": "<string>",
    "org_id": "<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

​
org_id
string
required

Body

application/json

Additional fields are forwarded to the virtual-accounts-service KYC endpoint. Full field set not statically defined in this service.

​
email
string<email>
required

Response

Bridge KYB initiated

​
status
string
​
message
string
​
data
object