Skip to main content

Claiming service provides APIs to Initiate and Verify the Claiming devices. You can read more about what Claiming is and type of claiming here

Initiate Claim

This API initiates the claiming process for devices. The mac_address is the input in initiate request along with the platform. The platform can be one of the valid platforms. The initiate request generates a claim. In case of authenticated claiming, a node_id is returned in the response. In case of unauthenticated claiming, auth_id and challenge are returned. The access_token can be passed as the authorisation header, it is optional in case of unauthenticated claiming

Valid Platforms are: ESP32, ESP32S2, ESP32C3, ESP32S3, ESP32C2, ESP32C6, ESP32H2

Platforms which supported Unauthenticated Claiming are: ESP32S3, ESP32S2, ESP32C3, ESP32C6, ESP32H2

Refer Initiate Claim Swagger For API for more details

If link navigation does not take you to the Claiming swagger then please select the RainMaker Claiming Service APIs definition.

Verify Claim

This API verifies the claiming request for devices. In case of authenticated claiming, the user passes the Certificate Signing Request and the claiming verify API returns the certificate for the device. For unauthenticated claiming, the user passes the auth_id, challenge_response and the Certificate Signing Request in the request. In the response, the device certificate is returned. If there are any failures ( claim quota is insufficient or invalid challenge_response ), an error is returned. The access_token can be passed as the authorisation header, but it is optional for esp32s2

Refer Verify Claim Swagger For API

If link navigation does not take you to the Claiming swagger then please select the RainMaker Claiming Service APIs definition.