Catalog

Check device compatibility

Checks if a device is compatible with eSIM functionality. Returns whether the specified device supports eSIM installation and activation.

get/catalog/devices/compatibility

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Query parameters

brandstringrequired

Device manufacturer/brand (e.g., "Apple", "Samsung", "Google")

modelstringrequired

Device model name (e.g., "iPhone 14 Pro", "Galaxy S23")

variantstring

Device variant or region code (e.g., "US", "EU", "Global")

Responses

200Device compatibility resultapplication/json

Show response body

dataobject

Show properties

compatiblebooleanrequired

Whether the device supports eSIM

400Bad request - invalid parameters 401Unauthorized - missing or invalid API key 403Forbidden - client does not have access to this resource 429Rate limit exceeded 500Internal server error

Request

curl 'https://connect.firsty.app/api/v3/catalog/devices/compatibility?brand=Apple&model=iPhone 14 Pro' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

fetch('https://connect.firsty.app/api/v3/catalog/devices/compatibility?brand=Apple&model=iPhone 14 Pro', {
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN'
  }
})

requests.get(
    "https://connect.firsty.app/api/v3/catalog/devices/compatibility",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
    params={
      "brand": "Apple",
      "model": "iPhone 14 Pro"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.firsty.app/api/v3/catalog/devices/compatibility', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN'
  ],
  'query' => [
    'brand' => 'Apple',
    'model' => 'iPhone 14 Pro'
  ]
]);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requestUrl := "https://connect.firsty.app/api/v3/catalog/devices/compatibility?brand=Apple&model=iPhone%2014%20Pro"

	req, _ := http.NewRequest("GET", requestUrl, nil)

	req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

curl 'https://connect.test.firsty.app/api/v3/catalog/devices/compatibility?brand=Apple&model=iPhone 14 Pro' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

fetch('https://connect.test.firsty.app/api/v3/catalog/devices/compatibility?brand=Apple&model=iPhone 14 Pro', {
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN'
  }
})

requests.get(
    "https://connect.test.firsty.app/api/v3/catalog/devices/compatibility",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
    params={
      "brand": "Apple",
      "model": "iPhone 14 Pro"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.test.firsty.app/api/v3/catalog/devices/compatibility', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN'
  ],
  'query' => [
    'brand' => 'Apple',
    'model' => 'iPhone 14 Pro'
  ]
]);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requestUrl := "https://connect.test.firsty.app/api/v3/catalog/devices/compatibility?brand=Apple&model=iPhone%2014%20Pro"

	req, _ := http.NewRequest("GET", requestUrl, nil)

	req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

{
  "data": {
    "compatible": true
  }
}

{
  "type": "https://developers.firsty.app/errors/validation-failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "Request contains invalid fields",
  "errors": [
    {
      "field": "planReference",
      "detail": "Must be a valid 14-character plan reference"
    }
  ]
}