> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.sare.africa/sare-core-api/identity/register-device/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.sare.africa/_mcp/server. # Register Device POST http://localhost:8080/api/v3/devices Content-Type: application/json Public (devices/** whitelisted) - typically called before login as part of device onboarding. Reference: https://apidocs.sare.africa/sare-core-api/identity/register-device ## Request ### Headers - `Authorization` (string, optional) ### Body (application/json) This endpoint expects an object. - `deviceId` (string, optional) - `deviceType` (string, optional) - `operatingSystem` (string, optional) - `operatingSystemVersion` (string, optional) - `appVersion` (string, optional) - `model` (string, optional) - `publicKeyPem` (string, optional) - `isRooted` (boolean, optional) - `isEmulator` (boolean, optional) - `isJailBroken` (boolean, optional) ## Response ### 200 200 OK - `code` (integer, optional) - `message` (string, optional) - `data` (DevicesPostResponsesContentApplicationJsonSchemaData, optional) ## Errors ### 400 Bad Request Error 400 Bad Request - bad public key - `status` (integer, optional) - `message` (string, optional) - `path` (string, optional) ## Types ### DevicesPostResponsesContentApplicationJsonSchemaData - `id` (string, optional) - `deviceId` (string, optional) - `deviceType` (string, optional) - `operatingSystem` (string, optional) - `operatingSystemVersion` (string, optional) - `appVersion` (string, optional) - `model` (string, optional) - `isRooted` (boolean, optional) - `isEmulator` (boolean, optional) - `isJailBroken` (boolean, optional) ## Examples **Request** ```json { "deviceId": "e2e-device-1a2b3c4d", "deviceType": "APP", "operatingSystem": "Android", "operatingSystemVersion": "14", "appVersion": "2.0.0", "model": "Pixel 8", "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\n-----END PUBLIC KEY-----", "isRooted": false, "isEmulator": false, "isJailBroken": false } ``` **Response** ```json { "code": 200, "message": "Device registered successfully", "data": { "id": "f5c1d4e5-2a3b-4c5d-8e9f-0a1b2c3d4e5f", "deviceId": "e2e-device-1a2b3c4d", "deviceType": "APP", "operatingSystem": "Android", "operatingSystemVersion": "14", "appVersion": "2.0.0", "model": "Pixel 8", "isRooted": false, "isEmulator": false, "isJailBroken": false } } ``` **SDK Code** ```python Identity_registerDevice_example import requests url = "http://localhost:8080/api/v3/devices" payload = { "deviceId": "e2e-device-1a2b3c4d", "deviceType": "APP", "operatingSystem": "Android", "operatingSystemVersion": "14", "appVersion": "2.0.0", "model": "Pixel 8", "publicKeyPem": "-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE... -----END PUBLIC KEY-----", "isRooted": False, "isEmulator": False, "isJailBroken": False } headers = { "Authorization": "Bearer {{accessToken}}", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Identity_registerDevice_example const url = 'http://localhost:8080/api/v3/devices'; const options = { method: 'POST', headers: {Authorization: 'Bearer {{accessToken}}', 'Content-Type': 'application/json'}, body: '{"deviceId":"e2e-device-1a2b3c4d","deviceType":"APP","operatingSystem":"Android","operatingSystemVersion":"14","appVersion":"2.0.0","model":"Pixel 8","publicKeyPem":"-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\n-----END PUBLIC KEY-----","isRooted":false,"isEmulator":false,"isJailBroken":false}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Identity_registerDevice_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:8080/api/v3/devices" payload := strings.NewReader("{\n \"deviceId\": \"e2e-device-1a2b3c4d\",\n \"deviceType\": \"APP\",\n \"operatingSystem\": \"Android\",\n \"operatingSystemVersion\": \"14\",\n \"appVersion\": \"2.0.0\",\n \"model\": \"Pixel 8\",\n \"publicKeyPem\": \"-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\\n-----END PUBLIC KEY-----\",\n \"isRooted\": false,\n \"isEmulator\": false,\n \"isJailBroken\": false\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer {{accessToken}}") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Identity_registerDevice_example require 'uri' require 'net/http' url = URI("http://localhost:8080/api/v3/devices") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer {{accessToken}}' request["Content-Type"] = 'application/json' request.body = "{\n \"deviceId\": \"e2e-device-1a2b3c4d\",\n \"deviceType\": \"APP\",\n \"operatingSystem\": \"Android\",\n \"operatingSystemVersion\": \"14\",\n \"appVersion\": \"2.0.0\",\n \"model\": \"Pixel 8\",\n \"publicKeyPem\": \"-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\\n-----END PUBLIC KEY-----\",\n \"isRooted\": false,\n \"isEmulator\": false,\n \"isJailBroken\": false\n}" response = http.request(request) puts response.read_body ``` ```java Identity_registerDevice_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("http://localhost:8080/api/v3/devices") .header("Authorization", "Bearer {{accessToken}}") .header("Content-Type", "application/json") .body("{\n \"deviceId\": \"e2e-device-1a2b3c4d\",\n \"deviceType\": \"APP\",\n \"operatingSystem\": \"Android\",\n \"operatingSystemVersion\": \"14\",\n \"appVersion\": \"2.0.0\",\n \"model\": \"Pixel 8\",\n \"publicKeyPem\": \"-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\\n-----END PUBLIC KEY-----\",\n \"isRooted\": false,\n \"isEmulator\": false,\n \"isJailBroken\": false\n}") .asString(); ``` ```php Identity_registerDevice_example request('POST', 'http://localhost:8080/api/v3/devices', [ 'body' => '{ "deviceId": "e2e-device-1a2b3c4d", "deviceType": "APP", "operatingSystem": "Android", "operatingSystemVersion": "14", "appVersion": "2.0.0", "model": "Pixel 8", "publicKeyPem": "-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\\n-----END PUBLIC KEY-----", "isRooted": false, "isEmulator": false, "isJailBroken": false }', 'headers' => [ 'Authorization' => 'Bearer {{accessToken}}', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Identity_registerDevice_example using RestSharp; var client = new RestClient("http://localhost:8080/api/v3/devices"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer {{accessToken}}"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"deviceId\": \"e2e-device-1a2b3c4d\",\n \"deviceType\": \"APP\",\n \"operatingSystem\": \"Android\",\n \"operatingSystemVersion\": \"14\",\n \"appVersion\": \"2.0.0\",\n \"model\": \"Pixel 8\",\n \"publicKeyPem\": \"-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\\n-----END PUBLIC KEY-----\",\n \"isRooted\": false,\n \"isEmulator\": false,\n \"isJailBroken\": false\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Identity_registerDevice_example import Foundation let headers = [ "Authorization": "Bearer {{accessToken}}", "Content-Type": "application/json" ] let parameters = [ "deviceId": "e2e-device-1a2b3c4d", "deviceType": "APP", "operatingSystem": "Android", "operatingSystemVersion": "14", "appVersion": "2.0.0", "model": "Pixel 8", "publicKeyPem": "-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE... -----END PUBLIC KEY-----", "isRooted": false, "isEmulator": false, "isJailBroken": false ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v3/devices")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```