---
agentTools:
  projectIndex: https://docs.privakey.com/llms.txt
---

# Register Webauthn Credential

Registers a webauthn credential with Privakey.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "2.4"
  },
  "servers": [
    {
      "url": "https://cloud.privakey.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/api/account/webauthn/register": {
      "post": {
        "summary": "Register Webauthn Credential",
        "description": "Registers a webauthn credential with Privakey.",
        "operationId": "register-webauthn-credential",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Either Basic or HMAC, depending on how the Request Origin is configured.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Basic <basic creds>"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "required": [
                  "accountId",
                  "credential"
                ],
                "properties": {
                  "accountId": {
                    "type": "string",
                    "description": "The user's account id"
                  },
                  "credential": {
                    "type": "string",
                    "description": "The result of the call to navigator.credentials.create() in a browser",
                    "format": "json"
                  },
                  "deviceName": {
                    "type": "string",
                    "description": "A nickname for the webauthn device"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Created": {
                    "value": "{\n    \"privakeyId\": \"a977ade7-bdcf-4c72-ac47-6a8619428aba\",\n    \"externalIdentifier\": \"9999999\",\n    \"deviceGuid\": \"6932cdc9-0c3d-4654-ac7d-eec20e4e1652\",\n    \"message\": \"Registration successful!\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "privakeyId": {
                      "type": "string",
                      "example": "a977ade7-bdcf-4c72-ac47-6a8619428aba"
                    },
                    "externalIdentifier": {
                      "type": "string",
                      "example": "9999999"
                    },
                    "deviceGuid": {
                      "type": "string",
                      "example": "6932cdc9-0c3d-4654-ac7d-eec20e4e1652"
                    },
                    "message": {
                      "type": "string",
                      "example": "Registration successful!"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": [],
        "x-readme": {
          "code-samples": [
            {
              "language": "curl",
              "code": "curl --location --request POST \"https://cloud.privakey.com/api/account/webauthn/register\" --header \"Authorization: Basic <basic creds>\" --header \"Content-Type: application/json\" --data \"{\"\"accountId\"\":\"\"999999\"\",\"\"credential\"\":{\"\"id\"\":\"\"uuIauIAYRi79M8HhOgsVVrZb8KWWnQJHAyKvcmwB-BM\"\",\"\"rawId\"\":\"\"uuIauIAYRi79M8HhOgsVVrZb8KWWnQJHAyKvcmwB-BM\"\",\"\"response\"\":{\"\"clientDataJSON\"\":\"\"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxlbmdlIjoiTGxpZmtvT3ZEQ0hFaUw3bjFrSmdmOGdCRDVoZ1h4UXJ5YmlJeWU2TXQyamZ4NWRXVzd0eHhDSmhGaWhrMzhvQ19KQWhzMG9ETkJaV0hURzU3X3cxLWFqQjJtRFhtdUd2cjRodTY3N0VTTG5TdVVpNGs4ZkFUOG9vZGlUSDlKV1l1WVpQc3poU3RFeVNhaFlUSzc3Q0VnVjQ2Mk11aGVQbDgzT29iaEVSYmJJIiwib3JpZ2luIjoiaHR0cDovL2xvY2FsaG9zdDo1NTAwIiwiY3Jvc3NPcmlnaW4iOmZhbHNlLCJvdGhlcl9rZXlzX2Nhbl9iZV9hZGRlZF9oZXJlIjoiZG8gbm90IGNvbXBhcmUgY2xpZW50RGF0YUpTT04gYWdhaW5zdCBhIHRlbXBsYXRlLiBTZWUgaHR0cHM6Ly9nb28uZ2wveWFiUGV4In0\"\",\"\"attestationObject\"\":\"\"o2NmbXRkbm9uZWdhdHRTdG10oGhhdXRoRGF0YVkBZ0mWDeWIDoxodDQXD2R2YFuP5K65ooYyx5lc87qDHZdjRQAAAAAAAAAAAAAAAAAAAAAAAAAAACC64hq4gBhGLv0zweE6CxVWtlvwpZadAkcDIq9ybAH4E6QBAwM5AQAgWQEAwoB-m29Bu7019ZMVQhpYPhb-mVkCJMnLH1fUtnLthI7w8e_a1n7vYHKQA5BZcJV5Y_XaKCMaM_exMyEusi2_OuMAncy75GqffcPSEHdpM3p9SItCFdM3-eNmBArt4VYcbdlZYtzGfh5ezNfJ2X75A5emCc6Aicuc4WfU9-5u7NNeeg63NmtS4xk1jNhRgvZY-NBcSxfYLQVHuMcVq010vl1zjnsREV0ZfhaX7LeCt-tYWwt_EcQyB_3TlbBssWzKq3dgj6QAhbk6IDVvNeCw3BZrM9t4kv-twJGZ4CohPhdwOTr_XEF5CMlj0PvLM4utw7bZNW4zDetc3We6Tbih6SFDAQAB\"\"}}}\""
            },
            {
              "language": "javascript",
              "code": "const body = {\"accountId\":\"9999999\",\n              \"credential\":{\"id\":\"uuIauIAYRi79M8HhOgsVVrZb8KWWnQJHAyKvcmwB-BM\",\"rawId\":\"uuIauIAYRi79M8HhOgsVVrZb8KWWnQJHAyKvcmwB-BM\",\n                            \"response\":{\"clientDataJSON\":\"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIiwiY2hhbGxlbmdlIjoiTGxpZmtvT3ZEQ0hFaUw3bjFrSmdmOGdCRDVoZ1h4UXJ5YmlJeWU2TXQyamZ4NWRXVzd0eHhDSmhGaWhrMzhvQ19KQWhzMG9ETkJaV0hURzU3X3cxLWFqQjJtRFhtdUd2cjRodTY3N0VTTG5TdVVpNGs4ZkFUOG9vZGlUSDlKV1l1WVpQc3poU3RFeVNhaFlUSzc3Q0VnVjQ2Mk11aGVQbDgzT29iaEVSYmJJIiwib3JpZ2luIjoiaHR0cDovL2xvY2FsaG9zdDo1NTAwIiwiY3Jvc3NPcmlnaW4iOmZhbHNlLCJvdGhlcl9rZXlzX2Nhbl9iZV9hZGRlZF9oZXJlIjoiZG8gbm90IGNvbXBhcmUgY2xpZW50RGF0YUpTT04gYWdhaW5zdCBhIHRlbXBsYXRlLiBTZWUgaHR0cHM6Ly9nb28uZ2wveWFiUGV4In0\",\n                                        \"attestationObject\":\"o2NmbXRkbm9uZWdhdHRTdG10oGhhdXRoRGF0YVkBZ0mWDeWIDoxodDQXD2R2YFuP5K65ooYyx5lc87qDHZdjRQAAAAAAAAAAAAAAAAAAAAAAAAAAACC64hq4gBhGLv0zweE6CxVWtlvwpZadAkcDIq9ybAH4E6QBAwM5AQAgWQEAwoB-m29Bu7019ZMVQhpYPhb-mVkCJMnLH1fUtnLthI7w8e_a1n7vYHKQA5BZcJV5Y_XaKCMaM_exMyEusi2_OuMAncy75GqffcPSEHdpM3p9SItCFdM3-eNmBArt4VYcbdlZYtzGfh5ezNfJ2X75A5emCc6Aicuc4WfU9-5u7NNeeg63NmtS4xk1jNhRgvZY-NBcSxfYLQVHuMcVq010vl1zjnsREV0ZfhaX7LeCt-tYWwt_EcQyB_3TlbBssWzKq3dgj6QAhbk6IDVvNeCw3BZrM9t4kv-twJGZ4CohPhdwOTr_XEF5CMlj0PvLM4utw7bZNW4zDetc3We6Tbih6SFDAQAB\"\n                                       }\n                           }\n             }\nconst options = {\n  headers: {'Authorization':`Basic ${basicCreds}`},\n  method: 'POST',\n  body\n}\n\nfetch('https://cloud.privakey.com/api/account/webauthn/register', options)\n  .then(data => console.log(data.privakeyId))"
            }
          ],
          "samples-languages": [
            "curl",
            "javascript"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "660d684fcb33080067214619:660d684fcb33080067214660"
}
```