Skip to main content
POST
/
v1
/
accounts
/
phone-number-activation-request
Request Phone Number Activation
curl --request POST \
  --url https://api.iklim.co/v1/accounts/phone-number-activation-request \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "296ff917-9b4b-4dc1-987d-2c17bdac7133",
  "accountId": "a5b5687b-ad68-44c1-b80c-c96de0d34b0a",
  "phoneNumberActivationPageLink": "https://api-manager.iklim.co/activation/mobile-phone-number"
}
'
{
  "userId": "<string>",
  "accountId": "<string>",
  "recipientPhoneNumber": "<string>",
  "tokenExpirationEpoch": 123,
  "smsSent": true
}

Body

application/json
​
userId
string<uuid>
required

User Identifier for Mobile Phone Activation

Example:

"296ff917-9b4b-4dc1-987d-2c17bdac7133"

​
accountId
string<uuid>
required

Account Identifier for Mobile Phone Activation

Example:

"a5b5687b-ad68-44c1-b80c-c96de0d34b0a"

​
phoneNumberActivationPageLink
string
required

Mobile Phone Activation Page Link

Example:

"https://api-manager.iklim.co/activation/mobile-phone-number"

Response

Phone Number Activation Request Successfully Sent

​
userId
string

User Identifier of Mobile Phone Activated User

​
accountId
string

Account Identifier of Mobile Phone Activated Account

​
recipientPhoneNumber
string

Mobile Phone Number to which SMS was Sent

​
tokenExpirationEpoch
integer<int64>

SMS Activation Token Expiration Time

​
smsSent
boolean

Was SMS Sent Successfully?