SIM Activation

This endpoint allows you to activate a SIM card with the provided details.

Endpoint

POST /v1/sim/activate/

Authentication

This endpoint requires authentication. You must include the Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Request Parameters

Parameter	Type	Required	Description
first_name	string	No	First name of the customer
middle_name	string	No	Middle name of the customer
last_name	string	No	Last name of the customer
alternate_phone_number	string	No	Alternate phone number
email	string	No*	Email address. *Required if is_esim is Y
pin	string	No	PIN for the activation
service_address_one	string	Yes	Service address line one
service_address_two	string	No	Service address line two
service_city	string	Yes	Service city
service_state	string	Yes	Service state
service_zip	string	Yes	Service ZIP code
plan_id	int	Yes	Plan ID associated with the activation
device_id	string	No	Device ID
imei	string	No	International Mobile Equipment Identity number
sim	string	Yes	SIM number
is_esim	string	Yes	Y for eSIM, N for physical SIM
action	string	Yes	Activation action string. Default: new_number_activation_with_zip_code
agent_id	string	Yes	Identifier of the activating agent (same as login username)
transaction_id	string	Yes	Unique random string generated with each request for tracking
source	string	No	Source of the activation request

Mandatory Fields

The following fields are mandatory for activation:

• sim
• plan_id
• service_zip
• agent_id
• transaction_id
• action

All other fields are optional, but if not provided, system-generated values may be used. If is_esim is Y, a valid email must also be provided.

Example Request

curl -X POST https://api.mw.vibemobi.com/v1/sim/activate/ \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cXVCJ9.eyJleHAiOjE3NDM2MzkwMTQsInN1YiI6IjdhOGM20hUvlViCXgL-RN2qr9EgkuWKHLlmpvX7UEMQ2wA" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "middle_name": "Robert",
    "last_name": "Smith",
    "alternate_phone_number": "2065551234",
    "email": "example@email.com",
    "pin": "1234",
    "service_address_one": "123 Main Street",
    "service_address_two": "Apt 456",
    "service_city": "New York",
    "service_state": "NY",
    "service_zip": "10001",
    "plan_id": 1234,
    "device_id": "DEVICE123456",
    "imei": "490154203237518",
    "sim": "8901234567891234567",
    "is_esim": "N",
    "action": "new_number_activation_with_zip_code",
    "agent_id": "AGENT001",
    "transaction_id": "TRANS123456789",
    "source": "API"
  }'

Response Examples

Successful Activation

{
    "message": "Success",
    "mdn": "2066097879",
    "sim": "8901240467112145661",
    "transaction_id": "8901240467112145653ADB"
}

Invalid Token

{
    "detail": "Could not validate credentials"
}

Already Active SIM

{
    "message": "Error occured",
    "error": [
        "SIM is not in free status",
        "SIM Already Used.",
        "Given SIM is already active with another customer ID 100091"
    ],
    "sim": "8901240467112145653",
    "transaction_id": "8901240467112145653AAB"
}

Invalid SIM

{
    "message": "Error occured",
    "error": [
        "SIM not found in Inventory.",
        "SIM not found in inventory."
    ],
    "sim": "890124046712145653",
    "transaction_id": "8901240467112145653AAB"
}

No Plan or Invalid Plan

{
    "message": "Error occured",
    "error": [
        "Please provide Plan ID or Plan Code",
        "SIM is not in free status",
        "SIM Already Used.",
        "Given SIM is already active with another customer ID 100095"
    ],
    "sim": "8901240467112145661",
    "transaction_id": "8901240467112145653ADB"
}

Invalid PIN

{
    "detail": "Failed to retrieve enrollment data from VCare API"
}

Missing SIM Number

{
    "message": "Error occured",
    "error": [
        "SIM should not be blank.",
        "SIM not found in inventory."
    ],
    "sim": "",
    "transaction_id": "8901240467112145653ADB"
}

Error Handling

When an error occurs during SIM activation, the API returns a JSON response with an error message and details. The response typically includes:

• A message field indicating the status (usually "Error occured")
• An error array containing specific error messages
• The sim number that was provided in the request
• The transaction_id for tracking purposes

It's important to check for these error responses in your application and handle them appropriately.

Red Flag Prevention

The system performs fraud prevention checks primarily for eSIM activations that may generate a Red Flag Report. These checks might also be applicable to physical SIM activations in some cases. To ensure smooth activation and avoid red flags, follow these guidelines:

Potential Red Flags

Red Flag	Description	Prevention
Same Password	Multiple accounts using identical login credentials	Use unique passwords for each account
Duplicate IMEI	The same device IMEI is associated with multiple accounts	Ensure IMEI numbers are unique and correctly entered
Billing Address Reuse	Multiple accounts sharing the same address	Verify address accuracy; use unique addresses when possible
Alternate Phone Number	The same alternate phone number used across multiple accounts	Provide unique alternate phone numbers for each account
Need Valid Email	Missing or invalid email address	Always provide a valid, unique email address (mandatory for eSIM activation)

eSIM Activation Requirements

For eSIM activation (is_esim = Y), a valid email address is mandatory. Invalid or missing email addresses will trigger a red flag and may prevent successful activation.