Skip to main content
Create a verification session for individual (KYC) or business (KYB) verification. Returns a session ID, redirect URL, and QR code.
This endpoint requires your API key and must only be called from your backend server. Never expose your API key in frontend code.

Request

cURL
curl -X POST "https://api.kyc.predicate.io/api/v1/register/individual?size=300" \
  -H "Authorization: Bearer $PREDICATE_KYC_API_KEY"

Response

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "redirectUrl": "https://identity.predicate.io/session/550e8400-e29b-41d4-a716-446655440000",
  "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSU..."
}

Endpoints

TypeEndpoint
Individual (KYC)POST https://api.kyc.predicate.io/api/v1/register/individual
Business (KYB)POST https://api.kyc.predicate.io/api/v1/register/business

Query Parameters

size
integer
default:"300"
QR code size in pixels. Must be between 80 and 2000.

Response Fields

sessionId
string
required
Unique session identifier (UUID)
redirectUrl
string
required
URL where the user completes verification
qrCode
string
required
Base64-encoded PNG QR code with data URI prefix

Authentication

Authorization: Bearer YOUR_API_KEY