Register

Initiate creation of new user

POST /auth/register/init

First call to make in order to register the user

Headers

Name	Value
Content-Type	application/json
platform	android|ios|web

Body (Json)

{
    "email": string
}

Response

200

{
  "publicKeyCredentialCreationOptions": {
    "attestation": string,
    "authenticatorSelection": {
        "requireResidentKey": true,
        "residentKey": string,
        "userVerification": string
    },
    "challenge": string,
    "excludeCredentials": [
        {
            "type": string;
            "id": number;
        }
    ],
    "otpUrl": string,
    "pubKeyCredParams": {
        {
            "type": string;
            "alg": number;
        }
    ],
    "rp": {
        "id": string,
        "name": string
    },
    "supportedCredentialKinds": {
        "firstFactor": ["Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey"],
        "secondFactor": ["Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey"]
    },
    "temporaryAuthenticationToken": string,
    "user": {
        "displayName": string,
        "id": string,
        "name": string
    }
  },
  "temporaryAuthenticationToken": string
}

Complete creation of new user

POST /auth/register

Finish register workflow; use the result of the previous call /auth/register/init

Authorization header is the temporaryAuthenticationToken from the /auth/register/init network call

Headers

Name	Value
Content-Type	application/json
x-join-key	api_token

Use the passkey authenticator depending on the operating system to generate the "attestation" object - Mobile: Use passkey library - Web: Web authenticator library

To create the recoveryCredential object you first need to create an object such as

"attestationData": {
    "publicKey": string,
    "signature": string,
    "algorithm": string
}

Body (Json)

{
  "attestation": {
    "id": string,
    "rawId": string,
    "response": {
        "attestationObject": string,
        "clientDataJSON": string
    },
    "type": string
  },
  "recoveryCredential": {
    "credentialInfo": {
        "attestationData": string,  // Base64Url encoded attestation data containing public key and signature
        "clientData": string,  // Base64Url encoded JSON representation of clientData
        "credId": string  // Base64Url encoded SHA-256 hash of the encrypted private key
    },
    "credentialKind": string, // "RecoveryKey"
    "encryptedPrivateKey": string  // Encrypted private key used for signing
  },
  "referral_code": string
}

Response

200

returns 200 with empty body if register has been completed successfully