Karrier Name Service
The Karrier Name Service API allows you to perform forward and reverse lookups between phone numbers and wallet addresses. It supports both single and bulk queries, ensuring efficient integration for
How It Works
π± Phone Lookup β Single
post
Body
phoneNumberstring Β· E.164RequiredExample:
The user's phone number in E.164 format.
+14445551234Pattern: ^\+?[1-9]\d{5,14}$Responses
200
Ok
application/json
addressstring Β· string Β· min: 66 Β· max: 66RequiredExample:
The wallet address
0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82Pattern: ^0x[0-9a-fA-F]{64}$defaultNSbooleanRequired
Whether the this is the default entry for the address
errorstringOptional
400Error
application/json
post/nameservice/phone-lookup
POST /nameservice/phone-lookup HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"phoneNumber": "+14445551234"
}{
"address": "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82",
"defaultNS": true,
"error": "text"
}π Phone Lookup β Bulk
post
Body
phoneNumbersstring[]Required
The user's phone number in E.164 format
Responses
200
Ok
application/json
addressstring Β· string Β· min: 66 Β· max: 66RequiredExample:
The wallet address
0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82Pattern: ^0x[0-9a-fA-F]{64}$defaultNSbooleanRequired
Whether the this is the default entry for the address
errorstringOptional
400Error
application/json
post/nameservice/phone-bulk-lookup
POST /nameservice/phone-bulk-lookup HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"phoneNumbers": [
"text"
]
}[
{
"address": "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82",
"defaultNS": true,
"error": "text"
}
]π³ Wallet Address Lookup β Single
post
Body
addressstring Β· string Β· min: 66 Β· max: 66RequiredExample:
The address to reverse lookup
0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82Pattern: ^0x[0-9a-fA-F]{64}$Responses
200
Ok
application/json
phoneNumberstring Β· E.164RequiredExample:
The user's phone number in E.164 format.
+14445551234Pattern: ^\+?[1-9]\d{5,14}$suinsbooleanRequired
Whether the address has SUINS enabled
errorstringOptional
400Error
application/json
post/nameservice/address-lookup
POST /nameservice/address-lookup HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"address": "0xa8c5cda072275d83ea87c6ee357edb344fa243aab071d552bdc4a7d69f741d82"
}{
"phoneNumber": "+14445551234",
"suins": true,
"error": "text"
}π³ Address Lookup β Bulk
post
Body
addressesstring[]Required
The SUI addresses to reverse lookup
Responses
200
Ok
application/json
phoneNumberstring Β· E.164RequiredExample:
The user's phone number in E.164 format.
+14445551234Pattern: ^\+?[1-9]\d{5,14}$suinsbooleanRequired
Whether the address has SUINS enabled
errorstringOptional
400Error
application/json
post/nameservice/address-bulk-lookup
POST /nameservice/address-bulk-lookup HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"addresses": [
"text"
]
}[
{
"phoneNumber": "+14445551234",
"suins": true,
"error": "text"
}
]Conclusion
Last updated