Skip to content

Register mobile biometrics

Request

Completes mobile biometrics registration in Transmit. Before calling this API, create an authenticator (cryptographic key-pair) on the end-user's device by invoking the client-side SDK provided by Transmit. This API must be called from the backend using the user access token returned upon successful authentication. If successful, the mobile biometrics authenticator will be registered for the user that corresponds to the authorization token.

Security
UserAccessToken
Bodyapplication/jsonrequired
device_idstring

The device associated with this registration.

publicKeystringrequired

Public key generated by SDK registration call

publicKeyIdstringrequired

ID of the public key

encryptionTypestring

Encryption type

Default:"rsa"
Enum:"rsa""ec"
challengestring

A string used to create attestation

attestation_encoded_resultstring

Encoded attestation data

osstringrequired

OS type

displayNamestring

Display name for the crypto key

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/mobile-biometrics/register \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "string",
    "publicKey": "string",
    "publicKeyId": "string",
    "encryptionType": "rsa",
    "challenge": "string",
    "attestation_encoded_result": "string",
    "os": "string",
    "displayName": "string"
  }'

Responses

The mobile biometrics authenticator has been successfully registered

Response
No content