API Reference
Frontend API
- Configs
- Users
- Auth
- POSTInitialize Authentication Process
- GETGet Authentication Process
- POSTComplete Authentication Process
- POSTReset Authentication Process
- POSTInitialize Signup
- POSTInitialize Login
- POSTSkip Authentication Block
- POSTStart Passkey Append
- POSTFinish Passkey Append
- POSTStart Passkey Login
- POSTFinish Passkey Login
- POSTFinish Passkey Mediation
- POSTStart Identifier Verification
- POSTFinish Identifier Verification
- GETGet Identifier Verification Status
- POSTUpdate Identifier
- POSTStart Social Verification
- GETSocial Verification Callback
- POSTFinish Social Verification
- POSTCreate Authentication Event
- POST
- CorbadoConnect
Backend API
- Users
- Challenges
- Identifiers
- AuthEvents
- PasskeyEvents
- PasskeyChallenges
- PasswordManagers
- ClientEnvs
- ProjectConfig
- ConnectTokens
- WebhookEndpoints
- Sessions
- Passkeys
Auth
Initialize Authentication Process
Initializes a new authentication process
POST
/
v2
/
auth
/
process
/
init
Copy
curl --request POST \
--url https://{projectId}.frontendapi.corbado.io/v2/auth/process/init \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
},
"passkeyAppendShown": 123,
"optOutOfPasskeyAppendAfterHybrid": true,
"preferredBlock": "signup-init"
}'
Copy
{
"newClientEnvHandle": "<string>",
"token": "<string>",
"expiresAt": 123,
"processResponse": {
"blockBody": {
"block": "signup-init",
"authType": "signup",
"data": {
"blockType": "<string>",
"challenge": "<string>",
"identifierValue": "<string>",
"identifierType": "email",
"autoSubmit": true,
"passkeyIconSet": "default",
"variant": "default"
},
"alternatives": [
{}
],
"error": {
"code": "<string>",
"message": "<string>"
},
"continueOnOtherDevice": {
"reason": "email-link-verified"
}
},
"common": {
"appName": "<string>",
"frontendApiUrl": "<string>",
"hideBadge": true,
"environment": "<string>"
},
"newProcess": {
"token": "<string>",
"expiresAt": 123
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
tbd.
Response
200 - application/json
tbd
tbd.
Was this page helpful?
Copy
curl --request POST \
--url https://{projectId}.frontendapi.corbado.io/v2/auth/process/init \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
},
"passkeyAppendShown": 123,
"optOutOfPasskeyAppendAfterHybrid": true,
"preferredBlock": "signup-init"
}'
Copy
{
"newClientEnvHandle": "<string>",
"token": "<string>",
"expiresAt": 123,
"processResponse": {
"blockBody": {
"block": "signup-init",
"authType": "signup",
"data": {
"blockType": "<string>",
"challenge": "<string>",
"identifierValue": "<string>",
"identifierType": "email",
"autoSubmit": true,
"passkeyIconSet": "default",
"variant": "default"
},
"alternatives": [
{}
],
"error": {
"code": "<string>",
"message": "<string>"
},
"continueOnOtherDevice": {
"reason": "email-link-verified"
}
},
"common": {
"appName": "<string>",
"frontendApiUrl": "<string>",
"hideBadge": true,
"environment": "<string>"
},
"newProcess": {
"token": "<string>",
"expiresAt": 123
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.