Send a verification code to my number

Issues a code to the number on file for the authenticated caller. 422 when no number is on file, 429 when rate-limited, 502 on delivery failure.

POST /api/v1/otp/phone-verifications

Send a verification code to my number

cURL

curl --request POST \
  --url https://sandbox.api.nkama.ga/api/v1/otp/phone-verifications \
  --header 'Authorization: Bearer <token>'

201

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

Authorizations

Authorization · string · header · required

Bearer access token (JWT) issued by Keycloak or the sandbox token endpoint.

Response

201 - */*

Created

challengeId · string

channel · enum<string>

Available options: WHATSAPP, SMS, EMAIL

expiresAt · string<date-time>

maskedDestination · string

purpose · enum<string>

Available options: PHONE_VERIFICATION, REGISTRATION, DOCUMENT_SIGNATURE, PASSWORD_RESET, PHONE_CHANGE