Customer Onboarding

Before users can make transactions, they must be registered and verified. You can either direct users to the Paytrie signup page or use the API to register them through your own interface.

API integration

For a seamless user experience, use the API to register users through your own interface.

Quick start

curl -X POST "https://api.paytrie.com/v2/users" \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "dob": "1990-01-15",
    "phone": "4165551234",
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 100",
    "city": "Toronto",
    "province": "on",
    "postalCode": "M5V1A1",
    "occupation": "Software Engineer",
    "pep": false,
    "tpd": false
  }'

The response will include the id of the newly created user record. You can subsequently use that to generate the kyc link.

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "john.doe@example.com",
    ...
  }
}

curl -X GET "https://api.paytrie.com/v2/users/550e8400-e29b-41d4-a716-446655440000/kyc-url" \
  -H "x-api-key: your-api-key"

Using the id from the previous response, you can call the generate KYC link endpoint to complete the onboarding flow.

{
  "success": true,
  "data": {
    "url": "https://sumsub.com/verify/...",
    "expiresAt": "2024-01-01T00:30:00.000Z"
  }
}

KYC verification flow

After registration, users must complete identity verification:

Paytrie uses Sumsub, a third-party identity verification provider, to handle KYC. The kyc-url opens Sumsub's hosted flow, where users upload identity documents and complete a liveness check.

Alternative: Sumsub reusable KYC

If your users have already completed KYC through Sumsub on your platform, you can import their verification data to skip the KYC step. See Sumsub Reusable KYC for details.