Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
sca-otp

Create Phone Number

Create a verified phone number for a user.

{% admonition type="warning" %} This endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API. {% /admonition %}

post/v1/application/users/{userId}/phone-numbers

Path parameters

userIdinteger required

User ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

phoneNumberstring

A valid phone number in string.

Response

OK

idinteger

ID of the phone number.

phoneNumberstring

A text representation of phone number.

typestring

Type of phone number when used in authentication.

Only PRIMARY is supported at the moment.

verifiedboolean

Indicator if phone number is verified.

clientIdstring

Client ID of which this phone number belongs to.

Example response

{
  "id": 1230944,
  "phoneNumber": "+6588888888",
  "type": "PRIMARY",
  "verified": true,
  "clientId": "clientId"
}