Number Pre-Registration

User pre-registration enables providers or telecom operators to pre-determine the crypto wallet address that will be associated with a user. This process is useful for sending assets (e.g., Welcome NFTs, gifts) or tracking user engagement.

Note: This does not grant the operator access to the wallet or its private keys.

How It Works

• Purpose: Pre-register a user with a specific crypto wallet address for asset distribution and engagement tracking.

• Security: The operator cannot access the user's wallet or its private keys.

API Endpoint: User Pre-Registration

Request Details

• Endpoint URL: https://kns-api.karrier.dev/kns/register-user-login

• HTTP Method: POST

• Headers:

  • x-api-key: testkey

  • Content-Type: application/json

• Payload Example:

  jsonCopy{
    "phoneNumber": "[phone]",
    "email": "[email protected]"
  }

cURL Example

bashCopycurl --location 'https://kns-api.karrier.dev/kns/register-user-login' \
--header 'x-api-key: testkey' \
--header 'Content-Type: application/json' \
--data-raw '{
  "phoneNumber": "[phone]",
  "email": "[email protected]"
}'

Sample Response

A successful request returns a JSON response similar to the example below:

jsonCopy{
  "success": true,
  "message": "User pre-registered successfully",
  "userId": "1ef57f69-0bb6-479f-aeb5-7ef21949520a",
  "zkAddress": "0x894033d5baf0a0cf8cc99f5cc03ee63c3666cb2dcc6c6717acf9dbfadfc49101",
  "identifiers": [
    {
      "identifier": "[email protected]",
      "type": "email"
    },
    {
      "identifier": "[phone]",
      "type": "phone"
    }
  ]
}

• success: Indicates the status of the request.

• message: Provides a brief summary of the operation.

• userId: A unique identifier for the pre-registered user.

• zkAddress: The crypto wallet address generated for the user.

• identifiers: Lists the user's identifiers, such as email and phone number.

Request & Response Details

This section outlines the key parameters, example requests, and sample responses for the API endpoint.

post

Body

application/json

emailstringOptional

The user's email address.

phoneNumberstring · E.164Optional

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

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

Responses

200

Ok

application/json

successbooleanRequired

messagestringRequired

userIdstringOptional

zkAddressstringOptional

400Error

application/json

post

/kns/register-user-login

HTTPcURLJavaScriptPython

POST /kns/register-user-login HTTP/1.1
Host: kns-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "email": "text",
  "phoneNumber": "[phone]"
}

{
  "success": true,
  "message": "text",
  "userId": "text",
  "identifiers": [
    {
      "type": "email",
      "identifier": "text"
    }
  ],
  "zkAddress": "text"
}

Conclusion

This API provides a streamlined way to pre-register users by associating a predetermined crypto wallet address with their account. If you have any questions or need further assistance, please feel free to contact us at [email protected].