API reference
Server API
Client API
- Overview
- GETGet Authenticators
- GETGet Authenticator Configurations
- SMS
- Email OTP
- Email magic link
- Authenticator app
- Passkey
- Push
- iProov (Face Biometrics)
Management API
- Overview
- GETGet Tenant
- Action Configurations
- Rules
- Custom Lists
- Custom Data Points
- Theme
Call Connect API
- Caller Authentication
Terminal API
- Payment Session
Server API
Enroll Verified Authenticator
Enroll an authenticator on behalf of a user. This operation should only be used in cases where you have already verified a user’s email address or phone number in your own system.
POST
/
users
/
{userId}
/
authenticators
curl --request POST \
--url https://api.authsignal.com/v1/users/{userId}/authenticators \
--header 'Content-Type: application/json' \
--data '{
"verificationMethod": "SMS",
"phoneNumber": "+123456789012"
}'
{
"authenticator": {
"userAuthenticatorId": "4efd2d0d-3278-4e03-8143-d9a0850bebc0",
"verificationMethod": "PASSKEY",
"username": "jane.smith@authsignal.com",
"displayName": "Jane Smith",
"createdAt": "2024-05-13T04:59:02.640Z",
"lastVerifiedAt": "2024-07-13T02:43:37.640Z",
"verifiedAt": "2024-05-13T04:59:17.640Z",
"webauthnCredential": {
"credentialId": "71273a99-4a7b-47d4-82ab-9ea72b8f0a72",
"deviceId": "d5a13d2d-8c34-4c90-938b-d8c6e3a88c5d",
"name": "iCloud Keychain",
"aaguid": "fbfc3007-154e-4ecc-8c0b-6e020557d7bd",
"aaguidMapping": {
"name": "iCloud Keychain",
"svgIconDark": "data:image/svg+xml;base64...",
"svgIconLight": "data:image/svg+xml;base64..."
},
"credentialBackedUp": true,
"credentialDeviceType": "multiDevice",
"authenticatorAttachment": "platform"
}
},
"recoveryCodes": [
"<string>"
]
}
Path Parameters
The ID of the user.
Body
application/json
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.authsignal.com/v1/users/{userId}/authenticators \
--header 'Content-Type: application/json' \
--data '{
"verificationMethod": "SMS",
"phoneNumber": "+123456789012"
}'
{
"authenticator": {
"userAuthenticatorId": "4efd2d0d-3278-4e03-8143-d9a0850bebc0",
"verificationMethod": "PASSKEY",
"username": "jane.smith@authsignal.com",
"displayName": "Jane Smith",
"createdAt": "2024-05-13T04:59:02.640Z",
"lastVerifiedAt": "2024-07-13T02:43:37.640Z",
"verifiedAt": "2024-05-13T04:59:17.640Z",
"webauthnCredential": {
"credentialId": "71273a99-4a7b-47d4-82ab-9ea72b8f0a72",
"deviceId": "d5a13d2d-8c34-4c90-938b-d8c6e3a88c5d",
"name": "iCloud Keychain",
"aaguid": "fbfc3007-154e-4ecc-8c0b-6e020557d7bd",
"aaguidMapping": {
"name": "iCloud Keychain",
"svgIconDark": "data:image/svg+xml;base64...",
"svgIconLight": "data:image/svg+xml;base64..."
},
"credentialBackedUp": true,
"credentialDeviceType": "multiDevice",
"authenticatorAttachment": "platform"
}
},
"recoveryCodes": [
"<string>"
]
}
Assistant
Responses are generated using AI and may contain mistakes.