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.
Individual (KYC)
Business (KYB)
Request
curl -X POST "https://api.identity.predicate.io/api/v1/register/individual?size=300" \
-H "Authorization: Bearer $PREDICATE_KYC_API_KEY"
Request (with wallet constraint)
curl -X POST "https://api.identity.predicate.io/api/v1/register/individual?size=300" \
-H "Authorization: Bearer $PREDICATE_KYC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"walletAddress": "0x1234567890abcdef1234567890abcdef12345678"}'
Response
{
"sessionId": "550e8400-e29b-41d4-a716-446655440000",
"redirectUrl": "https://identity.predicate.io/session/550e8400-e29b-41d4-a716-446655440000",
"qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSU..."
}
Request
curl -X POST "https://api.identity.predicate.io/api/v1/register/business?size=300" \
-H "Authorization: Bearer $PREDICATE_KYC_API_KEY"
Request (with wallet constraint)
curl -X POST "https://api.identity.predicate.io/api/v1/register/business?size=300" \
-H "Authorization: Bearer $PREDICATE_KYC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"walletAddress": "0x1234567890abcdef1234567890abcdef12345678"}'
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
| Type | Endpoint |
|---|
| Individual (KYC) | POST https://api.identity.predicate.io/api/v1/register/individual |
| Business (KYB) | POST https://api.identity.predicate.io/api/v1/register/business |
Query Parameters
QR code size in pixels. Must be between 80 and 2000.
Request Body (Optional)
Wallet address that must be used for this session.
Wallet Constraint: When you include walletAddress in the request:
- The user can only connect and verify with that specific wallet address
- If a session (
pending, retry, or completed) already exists for that wallet with the same verification type, the existing session is returned (session reuse)
- Sessions are only reused within the same check type (KYC sessions for
/register/individual, KYB for /register/business)
- Useful for pre-registering known wallet addresses or enforcing wallet constraints
HTTP Status Codes
| Status Code | Description |
|---|
201 Created | A new session was created |
200 OK | An existing session was reused (when walletAddress matched an existing reusable session) |
Response Fields
Unique session identifier (UUID)
URL where the user completes verification
Base64-encoded PNG QR code with data URI prefix
Authentication
Authorization: Bearer YOUR_API_KEY
