---
page_source: https://docs.juspay.io/upi-inapp/android/headless-process-payloads/get-sim-details
page_title: Get SIM Details
---


## Get SIM Details



This operation will provide the merchant to get Sim Details


###   Process Parameters



## Request Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String, Mandatory
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String, Mandatory
- **Payload**:
  - Description: Parameters required to call Hyper SDK API
  - Value:
    - **Action**:
      - Description: Operation to be performed in the SDK.
      - Value: upiGetSimDetails
      - Tags: String, Mandatory
  - Tags: JSON, Mandatory


## Response Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String
- **Payload**:
  - Description: Response Parameters
  - Value:
    - **Action**:
      - Description: Contains Action (upiGetSimDetails)
      - Value: upiGetSimDetails
      - Tags: String, Mandatory
    - **Status**:
      - Description: If upiGetSimDetails call was successful or failure
      - Value: SUCCESS/FAILURE
      - Tags: String, Mandatory
    - **SimDetails**:
      - Description: Contains Sim details i.e id, provider, simSerialNo, phoneNo(optional)
      - Value:
        - **Id**:
          - Description: SIM ID
          - Tags: String, Mandatory
        - **Provider**:
          - Description: Provider Name
          - Value: Example: JIO
          - Tags: String, Mandatory
        - **SimSerialNo**:
          - Description: Sim Serial Number
          - Tags: String, Mandatory
        - **PhoneNumber**:
          - Description: Masked Mobile Number
          - Tags: String, Optional
      - Tags: Array of JSON, Mandatory
  - Tags: JSON
- **Error**:
  - Description: Possible values :- true/false
  - Tags: Boolean
- **ErrorMessage**:
  - Description: Error Message
  - Tags: String
- **ErrorCode**:
  - Description: Error Code
  - Tags: String
- **Event**:
  - Description: Value: process_result
  - Tags: String





#### Code Snippets: -

#### Java Code Snippet:

```java
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSimDetails",
  }
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSimDetails",
  }
}
```


## Sample Code Snippets:
### Request snippets:

#### Request Code Snippet:

```request
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSimDetails",
  }
}
```

### Response snippets:

#### Response:
```plaintext
{
  "requestId": "<request id passed>",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSimDetails",
    "status": "SUCCESS/FAILURE",
    "simDetails": [
      {
        "id": "< id >",
        "provider": "< provider >",
        "simSerialNo": "< simSerialNo >",
        "phoneNumber": "< maskedMobileNumber >"
      },
      {
        "id": "< id >",
        "provider": "< provider >",
        "simSerialNo": "< simSerialNo >",
        "phoneNumber": "< maskedMobileNumber >"
      }
    ]
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}
```