---
title: "Check if a SIM swap has occurred within a given time window"
url: "https://developer.pxg.konera.com/apis/sim-swap-check-api-2/versions/372b9cc2-4eee-40a8-b684-79811e086b5e/operations/simSwapCheck"
---

> Full API specification: https://developer.pxg.konera.com/apis/sim-swap-check-api-2/versions/372b9cc2-4eee-40a8-b684-79811e086b5e.md

# Check if a SIM swap has occurred within a given time window

`POST` `/sim-swap/v2/check`

Operation ID: `simSwapCheck`

Checks whether a SIM swap has occurred for the given phone number within the specified maximum age (in seconds).

## Header parameters

- `x-correlation-id` (string, optional) - Correlation ID for request tracing

## Request body (required)

Content types: `application/json`

## Responses

- `200` - SIM swap status returned
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `429` - Too Many Requests
- `500` - Internal server error

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: SIM Swap Check API
  version: 2.0.0
servers:
  - url: https://api.pxg.konera.com/camara
    description: Production CAMARA API Gateway
paths:
  /sim-swap/v2/check:
    post:
      tags:
        - SIM Swap Check
      summary: Check if a SIM swap has occurred within a given time window
      description: Checks whether a SIM swap has occurred for the given phone number
        within the specified maximum age (in seconds).
      operationId: simSwapCheck
      parameters:
        - name: x-correlation-id
          in: header
          required: false
          description: Correlation ID for request tracing
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SimSwapCheckRequest"
            example:
              phoneNumber: "+14155550123"
              maxAge: 2400
      responses:
        "200":
          description: SIM swap status returned
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimSwapCheckResponse"
              example:
                simSwapped: false
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
security:
  - OAuth2ClientCredentials:
      - sim-swap.read
components:
  schemas:
    SimSwapCheckRequest:
      type: object
      required:
        - phoneNumber
        - maxAge
      properties:
        phoneNumber:
          type: string
          description: MSISDN in E.164 format
          example: "+14155550123"
        maxAge:
          type: integer
          description: Maximum age (in seconds) to look back for SIM swap events
          example: 2400
    SimSwapCheckResponse:
      type: object
      required:
        - simSwapped
      properties:
        simSwapped:
          type: boolean
          description: Indicates whether a SIM swap has occurred within the requested time
            window
          example: false
    Error:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: integer
          example: 400
        code:
          type: string
          example: INVALID_ARGUMENT
        message:
          type: string
          example: Invalid request
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.konera.com/oauth2/token
          scopes:
            sim-swap.read: Read SIM swap signal
```