Request a sign-up code

Sends a one-time code to the phone number and returns a challenge. Set whatsapp to deliver over WhatsApp first (falling back to SMS). Rate-limited per number and per IP; only served calling codes are accepted (422 otherwise).

POST /api/v1/registration/otp

Request a sign-up code

cURL

curl --request POST \
  --url https://sandbox.api.nkama.ga/api/v1/registration/otp \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "whatsapp": true
}
'

201

{
  "challengeId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "maskedDestination": "<string>"
}

Body

application/json

phoneNumber · string · required

Minimum string length: 1

Pattern: ^\+[1-9]\d{6,14}$

whatsapp · boolean

Response

201 - */*

Created

challengeId · string

channel · enum<string>

Available options: WHATSAPP, SMS, EMAIL

expiresAt · string<date-time>

maskedDestination · string