API Reference
Frontend API
- Configs
- Users
- GETGet Current User
- DELDelete Current User
- PATCHUpdate Current User
- GETGet User Passkeys
- POSTStart Passkey Append
- POSTFinish Passkey Append
- DELDelete User Passkey
- POSTRefresh Session
- POSTLogout User
- POSTCreate Identifier
- DELDelete Identifier
- PATCHUpdate Identifier
- POSTStart Identifier Verification
- POSTFinish Identifier Verification
- GET
- Auth
- CorbadoConnect
Backend API
- Users
- Challenges
- Identifiers
- AuthEvents
- PasskeyEvents
- PasskeyChallenges
- PasswordManagers
- ClientEnvs
- ProjectConfig
- ConnectTokens
- WebhookEndpoints
- Sessions
- Passkeys
Users
Start Identifier Verification
Creates challenge (only email otp and phone otp supported for now)
POST
/
v2
/
me
/
identifier
/
verify
/
start
Copy
curl --request POST \
--url https://{projectId}.frontendapi.corbado.io/v2/me/identifier/verify/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"identifierID": "<string>",
"clientInformation": {
"bluetoothAvailable": true,
"clientEnvHandle": "<string>",
"visitorId": "<string>",
"canUsePasskeys": true,
"isUserVerifyingPlatformAuthenticatorAvailable": true,
"isConditionalMediationAvailable": true,
"clientCapabilities": {
"conditionalCreate": true,
"conditionalMediation": true,
"hybridTransport": true,
"passkeyPlatformAuthenticator": true,
"userVerifyingPlatformAuthenticator": true
},
"javaScriptHighEntropy": {
"platform": "<string>",
"platformVersion": "<string>",
"mobile": true
},
"isNative": true,
"webdriver": true,
"privateMode": true,
"clientEnvHandleMeta": {
"ts": 123,
"source": "ls"
}
}
}'
Copy
{
"httpStatusCode": 123,
"message": "OK",
"requestData": {
"requestID": "req-557...663",
"link": "https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx"
},
"runtime": 0.06167686
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
tbd.
Response
200 - application/json
Operation succeeded
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://{projectId}.frontendapi.corbado.io/v2/me/identifier/verify/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"identifierID": "<string>",
"clientInformation": {
"bluetoothAvailable": true,
"clientEnvHandle": "<string>",
"visitorId": "<string>",
"canUsePasskeys": true,
"isUserVerifyingPlatformAuthenticatorAvailable": true,
"isConditionalMediationAvailable": true,
"clientCapabilities": {
"conditionalCreate": true,
"conditionalMediation": true,
"hybridTransport": true,
"passkeyPlatformAuthenticator": true,
"userVerifyingPlatformAuthenticator": true
},
"javaScriptHighEntropy": {
"platform": "<string>",
"platformVersion": "<string>",
"mobile": true
},
"isNative": true,
"webdriver": true,
"privateMode": true,
"clientEnvHandleMeta": {
"ts": 123,
"source": "ls"
}
}
}'
Copy
{
"httpStatusCode": 123,
"message": "OK",
"requestData": {
"requestID": "req-557...663",
"link": "https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx"
},
"runtime": 0.06167686
}
Assistant
Responses are generated using AI and may contain mistakes.