Learn how to use the Authsignal SDKs for iOS, Android, React Native, and Flutter.
Region | API URL |
---|---|
US (Oregon) | https://api.authsignal.com/v1 |
AU (Sydney) | https://au.api.authsignal.com/v1 |
EU (Dublin) | https://eu.api.authsignal.com/v1 |
webcredentials
service type.apple-app-site-association
file on the domain that matches your relying party:ABCDE12345
is your team id and com.example.app
is your bundle identifier.webcredentials
entry for your domain / relying party e.g. example.com
:signIn
will present the passkey sign-in prompt if a credential is available on the device.
If the user successfully authenticates with their passkey, send the result token to your server to validate the challenge.
^[a-zA-Z0-9_-]{(1, 64)}$
.textContentType
property.
signIn
to present the passkey sign-in prompt, you will need to cancel a request that is already in progress (e.g. an autofill request).
timeout
param determines the time (in seconds) that the credential can be accessed after authenticating - or 0
if authentication must occur for every credential use.
The authorizationType
param determines if authentication is required via biometrics and/or device credential (e.g. pin).
If user authentication is required for a credential, you must call updateChallenge
in a biometric prompt authentication callback.
claimChallenge
to set the user attempting to complete the challenge. This will return some context about the desktop or kiosk device initiating the challenge such as ip address, location, user agent and custom data. This data can be shown to the user to help them decide if they want to approve or decline the challenge.
timeout
param determines the time (in seconds) that the credential can be accessed after authenticating - or 0
if authentication must occur for every credential use.
The authorizationType
param determines if authentication is required via biometrics and/or device credential (e.g. pin).
If user authentication is required for a credential, you must call updateChallenge
in a biometric prompt authentication callback.
add:authenticators
when tracking the
action if the user already has an existing authenticator. For more detail refer to our guide on
how to ensure a strong binding when adding
authenticators.setToken
method.
You must use the same token for the initial enroll/challenge call and the subsequent verify call.