Info: Use our API endpoints for Get CID and PidMS (Check Keys), or install the WordPress plugin to add both services to your website.
iid (mandatory): Your Installation ID. It can be sent with or without hyphens.
token (mandatory): Your token. See Token authentication above.
onlycid (optional, default 0): Set onlycid to 1 to omit user information from the response.
lang (optional, default en): Language used in the server response.
Available languages: en, es, pt, fr, ar, id, tr, ru, zh, it, vi, pl, ko.
https://bs.getcid.xyz/webapi/getcid/?token=abcdef&iid=7661415465...https://bs.getcid.xyz/webapi/getcid/?token=abcdef&lang=es&iid=6662416...curl --request GET \
--url "https://bs.getcid.xyz/webapi/getcid/?token=YOUR_URL_TOKEN&iid=7661415465827916162801512875466823083683014123514870464278210337292118364446352391&lang=es"If everything is correct, the server returns JSON in this format:
{ "cid": "435504-697485-138242-433182-497552-083534-176493-978266", "c_cid": "435504697485138242433182497552083534176493978266", "user_data": { "credit": 100, "autocall_price": 0.5 } }
The errorDetail field provides details about errors.
FAST CID:Fast CID! Check again in 15 seconds.
COMMON ERRORS:If something goes wrong, the response looks like this:
{ "errorDetail": "Invalid Installation ID.", "user_data": { "credit": 100, "autocall_price": 0.5 } }
Info: Your current credit is always returned. Credit is deducted only after a successful call. Requests are prevented when available credit is insufficient or reserved by pending calls.
key (mandatory): Your key in the exact format XXXXX-XXXXX-XXXXX-XXXXX-XXXXX.
token (mandatory): Your token. See Token authentication above.
timezone (optional, default UTC): Set a timezone to display time in your zone. See valid timezones here.
show_provider (optional, default 1): Set show_provider to 0 to omit the provider name (getcid.xyz) from the response.
format (optional, default string): Supported values are string, json, xml and legacy. Use legacy for the previous response shape with a single detail field.
https://bs.getcid.xyz/webapi/pidms/?token=abcdef&key=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX&format=jsoncurl --request GET \
--url "https://bs.getcid.xyz/webapi/pidms/?token=YOUR_URL_TOKEN&key=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX&timezone=UTC"PidMS supports multiple response formats through the format parameter:
format=string (default)Key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX Description: Win 2021 RTM EnterpriseS Volume:MAK Edition: EnterpriseS Error: 0xC004C008 [Get CID on getcid.xyz] Time: 2026-01-03 22:27:42 +00:00 Remaining count: 0
Plain text response with one field per line.
format=json{ "key": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX", "description": "Win 2021 RTM EnterpriseS Volume:MAK", "edition": "EnterpriseS", "error": "0xC004C008 [Get CID on getcid.xyz]", "time": "2026-01-03 22:27:42 +00:00", "remaining_count": 0 }
Structured JSON object with separate fields.
format=xml<response> <key>XXXXX-XXXXX-XXXXX-XXXXX-XXXXX</key> <description>Win 2021 RTM EnterpriseS Volume:MAK</description> <edition>EnterpriseS</edition> <error>0xC004C008 [Get CID on getcid.xyz]</error> <time>2026-01-03 22:27:42 +00:00</time> <remaining_count>0</remaining_count> </response>
Use this when your integration expects XML.
format=legacy{ "detail": "Key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX\nDescription: Win 2021 RTM EnterpriseS Volume:MAK\nEdition: EnterpriseS\nError: 0xC004C008 [Get CID on getcid.xyz]\nTime: 2026-01-03 22:27:42 +00:00\nRemaining count: 0" }
Preserves the previous API shape with a single detail field.
COMMON ERRORS:If something goes wrong with format=json, the server returns a response like this:
{ "key": "Invalid Format" }
Info: PidMS (check keys) is a free service provided by getcid.xyz.
Add GetCID and PidMS (Check Keys) automatically without programming knowledge. Upload and install the plugin, create pages with [getcid] and [pidms], and you are ready.
[getcid] for the GetCID form.[pidms] for the PidMS (Check Keys) form.