Skip to main content
Registers a new client terminal with the system. This endpoint requires client details and the public key generated from the /generateKeys endpoint.

​
Endpoint

POST /isw/auth/registerClient

​
Authentication

No authentication required for initial registration.

​
Request body

​
name
string
required
The name of the company or client
​
phoneNumber
string
required
Client’s phone number
​
nin
string
required
National Identification Number
​
gender
string
required
Gender of the client contact
​
emailAddress
string
required
Client’s email address
​
ownerPhoneNumber
string
required
Phone number of the business owner
​
publicKey
string
required
RSA public key generated from the /generateKeys endpoint
​
clientSessionPublicKey
string
Client’s session public key for secure communication
​
requestReference
string
Unique reference for this request
​
terminalId
string
Terminal identifier (inherited from ClientTerminalRequest)
​
appVersion
string
Version of the client application
​
serialId
string
Serial ID of the terminal device
​
gprsCoordinate
string
GPS coordinates of the terminal

​
Response

Returns a string response indicating the registration status or a registration token.

​
Example request

cURL
curl --request POST \
  --url http://localhost:8081/isw/auth/registerClient \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Company Name",
  "phoneNumber": "123-456-7890",
  "nin": "123456789",
  "gender": "Male",
  "emailAddress": "[email protected]",
  "ownerPhoneNumber": "987-654-3210",
  "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA..."
}'

​
Example response

"Registration successful"

Build docs developers (and LLMs) love

Get started for freeTalk to us