Caller Verification API

The Caller Verification API enables verification of phone call integrity and user registration by using JWT signatures and mapping phone numbers to object IDs.

How It Works

This API offers two primary endpoints:

1. Call Signature Verification – Verify a JWT signature between caller and callee numbers.

2. Object ID Lookup – Retrieve a KNS object ID associated with a phone number.

Both endpoints use POST with JSON payloads and require API key authorization.

📞 Call Signature Verification

post

Authorizations

x-api-keystringRequired

Body

origTNstring · E.164Required

The origination phone number in E.164 format.

Example: [phone]Pattern: ^\+?[1-9]\d{5,14}$

destTNstring · E.164Required

The destination phone number in E.164 format.

Example: [phone]Pattern: ^\+?[1-9]\d{5,14}$

jwtstringRequired

The JWT identity header to be verified

debugbooleanOptional

Responses

200

Ok

application/json

successbooleanRequired

400Error

application/json

post/kns/call-signature-verification

POST /kns/call-signature-verification HTTP/1.1
Host: kns-api.karrier.one
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "origTN": "[phone]",
  "destTN": "[phone]",
  "jwt": "text",
  "debug": true
}

{
  "success": true
}

🆔 Object ID Lookup

post

Authorizations

x-api-keystringRequired

Body

phoneNumberstring · E.164Required

The user's phone number in E.164 format.

Example: [phone]Pattern: ^\+?[1-9]\d{5,14}$

Responses

200

Ok

application/json

objectIdstring · string · min: 66 · max: 66Required

The Sui object ID of the KNS NFT

Example: 0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82Pattern: ^0x[0-9a-fA-F]{64}$

registriesstring[]Required

The Sui object IDs of the Certificate Registries associated with the user's phone number.

Example: ["0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82"]

400Error

application/json

post/kns/object-id-lookup

POST /kns/object-id-lookup HTTP/1.1
Host: kns-api.karrier.one
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "phoneNumber": "[phone]"
}

{
  "objectId": "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82",
  "registries": [
    "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82"
  ]
}

Conclusion

The Caller Verification API makes verifying call authenticity and resolving phone numbers to KNS objects seamless. For questions or help, contact [e-mail].

🔗 Reference

kns-api-swagger.json

42KB

Open

Karrier Number System OpenAPI Specification