Skip to main content
POST
/
kyb
Create a KYB record
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/kyb \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "user_id": "<string>",
  "org_id": "<string>",
  "userCreatedAt": "<string>",
  "orgCreatedAt": "<string>",
  "businessInfo": {
    "businessName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "businessWebsite": "<string>",
    "country": "<string>",
    "emailAddress": "jsmith@example.com",
    "industry": "<string>",
    "phoneNumber": "<string>",
    "postalCode": "<string>",
    "regionState": "<string>"
  },
  "kybDocuments": {
    "companyLogo": {
      "file_url": "<string>",
      "original_filename": "<string>"
    },
    "companyRegistrationAndOwnershipDocuments": {
      "file_url": "<string>",
      "original_filename": "<string>"
    },
    "companyRegistrationNumber": "<string>",
    "isRegisteredEntity": true,
    "registrationType": "<string>",
    "taxIdentificationNumber": "<string>",
    "idOfDirectorsOrOwners": [
      {
        "file_url": "<string>",
        "original_filename": "<string>"
      }
    ]
  }
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {}
}

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
org_id
string
required
userCreatedAt
string
required

ISO 8601 datetime string

orgCreatedAt
string
required

ISO 8601 datetime string

businessInfo
object
kybDocuments
object

Response

KYB record created

status
string
Example:

"success"

message
string
data
object