All Products
Search

This Product

    Identity as a Service:GetUserIdByPhoneNumber

    Document Center

    Identity as a Service:GetUserIdByPhoneNumber

    Last Updated:Mar 30, 2026

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

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    applicationId

    string

    Yes

    The application ID.

    app_mkv7rgt4d7i4u7zqtzev2mxxxx

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Authorization

    string

    Yes

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

    Bearer AT8csE2seYxxxxxij

    body

    object

    No

    The request body.

    phoneNumber

    string

    Yes

    The mobile number of the user who owns the account.

    156xxxxxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    userId

    string

    The account ID.

    user_d6sbsuumeta4h66ec3il7yxxxx

    Examples

    Success response

    JSON format

    {
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.