Get registration options

GET

/auth/registration

const url = 'https://web.exactly.app/api/auth/registration';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://web.exactly.app/api/auth/registration

Initiates WebAuthn registration by generating credential creation options for a new user. Sets a session HTTP-only cookie.

Parameters

Query Parameters

credentialId

Ethereum address

Address to register with, if using Sign-in with Ethereum.

string

Responses

200

WebAuthn registration options containing challenge, relying party info, and credential parameters for client-side credential creation

application/json

One of:

Sign-in with Ethereum
WebAuthn

Sign-in with Ethereum

object

method

required

Method

Sign-in with Ethereum.

Allowed values: siwe

address

required

Address

Address to sign in with.

string

message

required

Message

Message to sign.

string

WebAuthn

object

method

required

Method

WebAuthn.

Allowed values: webauthn

required

Service

Service the credential is being created for.

object

name

required

Service name

Name of the service being registered with.

string

Service domain

Domain of the service being registered with.

string

user

required

User

Account information.

object

required

User identifier

Unique identifier in the service.

string

name

required

Username

Username in the service.

string

displayName

required

Display name

Name to be shown to the user.

string

challenge

required

Cryptographic challenge

Random bytes to be signed.

string

pubKeyCredParams

required

Array<object>

object

type

required

Credential type

Always public-key for WebAuthn.

Allowed values: public-key

alg

required

Cryptographic algorithm

Should be ES256 (-7) for Ethereum-compatible cryptography.

Allowed values: -7

timeout

Time limit

Maximum time to complete registration.

number

excludeCredentials

Array<object>

object

required

Credential identifier

Identifier of an existing credential.

string

type

required

Credential type

Always public-key for WebAuthn.

Allowed values: public-key

transports

Transport methods

How the credential can be used.

Array<string>

authenticatorSelection

object

authenticatorAttachment

Authenticator type

Type of authenticator to use.

string

residentKey

Resident key

Whether to create a discoverable credential.

string

userVerification

User verification

Whether user presence must be verified.

string

requireResidentKey

Require resident key

Whether a discoverable credential is required.

boolean

hints

UI hints

Type of authentication UI to show.

Array<string>

attestation

Attestation

How to handle authenticator attestation.

string

attestationFormats

Attestation formats

What attestation formats to accept.

Array<string>

extensions

Extensions

Additional features to enable.

object

key

additional properties

Example

{
  "method": "siwe"
}