Karrier Number System API
The Karrier Number System API provides a secure way to register users, create and manage approvals, and verify identities and transactions using zk addresses, approval references, and signatures.
How It Works
Each endpoint supports either POST or GET methods with JSON bodies or query parameters. The API handles identity registration, approval workflows (like SIM swaps), and cryptographic verification.
🧾 Register User Login
The user's email address.
The user's phone number in E.164 format.
+14445551234Pattern: ^\+?[1-9]\d{5,14}$Ok
POST /kns/register-user-login HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"email": "text",
"phoneNumber": "+14445551234"
}{
"success": true,
"message": "text",
"userId": "text",
"identifiers": [
{
"type": "email",
"identifier": "text"
}
],
"zkAddress": "text"
}✅ Create Approval – Phone
The title of the approval request.
SIM Replacement ApprovalA description of what the approval request is for.
Would you like to deactivate your previous SIM card and activate a new SIM card?The URL to redirect to if the user approves the request.
https://example.com/approvedPattern: ^https?:\/\/.*$The URL to redirect to if the user cancels the approval request.
https://example.com/cancelPattern: ^https?:\/\/.*$The reference number for the approval request.
SIM-1234The method to use for the approval request. This can be either "sign" or "event".
signPossible values: The user's phone number in E.164 format.
+14445551234Pattern: ^\+?[1-9]\d{5,14}$Ok
POST /kns/approval-phone HTTP/1.1
Host: kns-api.karrier.one
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 304
{
"title": "SIM Replacement Approval",
"message": "Would you like to deactivate your previous SIM card and activate a new SIM card?",
"successRedirectUrl": "https://example.com/approved",
"cancelRedirectUrl": "https://example.com/cancel",
"referenceNumber": "SIM-1234",
"method": "sign",
"phoneNumber": "+14445551234"
}{
"approvalUrl": "text",
"approvalNumber": "text",
"error": "text"
}🪪 Create Approval – Object ID
The title of the approval request.
SIM Replacement ApprovalA description of what the approval request is for.
Would you like to deactivate your previous SIM card and activate a new SIM card?The URL to redirect to if the user approves the request.
https://example.com/approvedPattern: ^https?:\/\/.*$The URL to redirect to if the user cancels the approval request.
https://example.com/cancelPattern: ^https?:\/\/.*$The reference number for the approval request.
SIM-1234The method to use for the approval request. This can be either "sign" or "event".
signPossible values: The Sui object ID of the KNS NFT.
0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82Pattern: ^0x[0-9a-fA-F]{64}$Ok
POST /kns/approval-object-id HTTP/1.1
Host: kns-api.karrier.one
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 355
{
"title": "SIM Replacement Approval",
"message": "Would you like to deactivate your previous SIM card and activate a new SIM card?",
"successRedirectUrl": "https://example.com/approved",
"cancelRedirectUrl": "https://example.com/cancel",
"referenceNumber": "SIM-1234",
"method": "sign",
"objectId": "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82"
}{
"approvalUrl": "text",
"approvalNumber": "text",
"error": "text"
}🔍 Get Transaction Details
Ok
The Sui object ID of the KNS NFT
0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82Pattern: ^0x[0-9a-fA-F]{64}$The user's phone number in E.164 format.
+14445551234Pattern: ^\+?[1-9]\d{5,14}$GET /kns/transaction_details?ref=text HTTP/1.1
Host: kns-api.karrier.one
Accept: */*
{
"title": "text",
"message": "text",
"objectId": "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82",
"successRedirectUrl": "text",
"cancelRedirectUrl": "text",
"approvalNumber": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"approved": true,
"method": "text",
"phoneNumber": "+14445551234",
"wallet": "text",
"vendorBrand": "text"
}✍️ Verify Signature
Ok
POST /kns/verify_signature HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"signature": "text",
"approvalNumber": "text"
}{
"success": true,
"error": "text"
}🔐 Verify Transaction Digest
Ok
POST /kns/verify_transaction HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"digest": "text",
"approvalNumber": "text"
}{
"success": true,
"error": "text"
}Conclusion
The Karrier Number System API enables secure and seamless identity verification, approvals, and transaction validation. For questions or support, please reach out to support@karrier.one.
🔗 Reference
Last updated