curl --request POST \
--url https://backendapi.corbado.io/v2/passkey/login/start \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"userID": "<string>",
"clientInformation": {
"remoteAddress": "::ffff:172.18.0.1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
"clientEnvHandle": "<string>",
"javascriptFingerprint": "<string>",
"javaScriptHighEntropy": {
"platform": "<string>",
"platformVersion": "<string>",
"mobile": true
},
"bluetoothAvailable": true,
"passwordManagerAvailable": true,
"userVerifyingPlatformAuthenticatorAvailable": true,
"conditionalMediationAvailable": true,
"privateMode": true,
"parsedDeviceInfo": {
"browserName": "<string>",
"browserVersion": "<string>",
"osName": "<string>",
"osVersion": "<string>"
},
"nativeMeta": {
"build": "<string>",
"deviceOwnerAuth": "<string>",
"isPlatformAuthenticatorAPISupported": true,
"isBluetoothAvailable": true,
"isBluetoothOn": true,
"googlePlayServices": true,
"deviceSecure": true
}
},
"crossDeviceAuthenticationStrategy": "standard",
"processID": "<string>"
}'
{
"loginAllow": true,
"assertionOptions": "<string>",
"detectionInsights": {
"tags": [
{
"category": "support",
"name": "<string>"
}
],
"credentialIds": [
"<string>"
],
"clientEnvIds": [
"<string>"
],
"passwordManagerIds": [
"<string>"
],
"historyData": {
"defaultCount": 123,
"afterErrorCount": 123,
"afterHybridCount": 123,
"autoCount": 123,
"defaultCooldown": true,
"afterErrorCooldown": true,
"afterHybridCooldown": true,
"autoCooldown": true
}
},
"decisionInsights": {
"tag": "env-no-platform-pk-support",
"isCDACandidate": true,
"experiments": [
"<string>"
],
"preferImmediatelyAvailable": true
}
}
Starts login with an existing passkey by initiating the WebAuthn ceremony. To complete the ceremony you need to call finish.
curl --request POST \
--url https://backendapi.corbado.io/v2/passkey/login/start \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"userID": "<string>",
"clientInformation": {
"remoteAddress": "::ffff:172.18.0.1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
"clientEnvHandle": "<string>",
"javascriptFingerprint": "<string>",
"javaScriptHighEntropy": {
"platform": "<string>",
"platformVersion": "<string>",
"mobile": true
},
"bluetoothAvailable": true,
"passwordManagerAvailable": true,
"userVerifyingPlatformAuthenticatorAvailable": true,
"conditionalMediationAvailable": true,
"privateMode": true,
"parsedDeviceInfo": {
"browserName": "<string>",
"browserVersion": "<string>",
"osName": "<string>",
"osVersion": "<string>"
},
"nativeMeta": {
"build": "<string>",
"deviceOwnerAuth": "<string>",
"isPlatformAuthenticatorAPISupported": true,
"isBluetoothAvailable": true,
"isBluetoothOn": true,
"googlePlayServices": true,
"deviceSecure": true
}
},
"crossDeviceAuthenticationStrategy": "standard",
"processID": "<string>"
}'
{
"loginAllow": true,
"assertionOptions": "<string>",
"detectionInsights": {
"tags": [
{
"category": "support",
"name": "<string>"
}
],
"credentialIds": [
"<string>"
],
"clientEnvIds": [
"<string>"
],
"passwordManagerIds": [
"<string>"
],
"historyData": {
"defaultCount": 123,
"afterErrorCount": 123,
"afterHybridCount": 123,
"autoCount": 123,
"defaultCooldown": true,
"afterErrorCooldown": true,
"afterHybridCooldown": true,
"autoCooldown": true
}
},
"decisionInsights": {
"tag": "env-no-platform-pk-support",
"isCDACandidate": true,
"experiments": [
"<string>"
],
"preferImmediatelyAvailable": true
}
}
Basic authentication is used to authenticate requests to the Backend API. The username is the project ID and the password is the API secret.
The project ID and API secret can be found in the Developer Panel.
Passkey authentication process has been started.
The response is of type object
.
Was this page helpful?