All Products
Search
Document Center

Identity as a Service:GetUserIdByPhoneNumber

Last Updated:Jul 31, 2025

Queries the ID of an Employee Identity and Access Management (EIAM) account based on the mobile number.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByPhoneNumber HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
AuthorizationstringYes

The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.

Bearer AT8csE2seYxxxxxij
instanceIdstringYes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx
applicationIdstringYes

The application ID.

app_mkv7rgt4d7i4u7zqtzev2mxxxx
bodyobjectNo

The request body.

phoneNumberstringYes

The mobile number of the user who owns the account.

156xxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

userIdstring

The account ID.

user_d6sbsuumeta4h66ec3il7yxxxx

Examples

Sample success responses

JSONformat

{
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-24The internal configuration of the API is changed, but the call is not affectedView Change Details