Complete End User Registration with Wallets
POST /auth/registration/enduser
Completes the end user registration process and creates the user's initial credentials along with delegated wallets for the new end user.
The type of credentials being registered is determined by the credentialKind
field in the nested objects (firstFactorCredential
, secondFactorCredential
and RecoveryCredential
). Supported credential kinds are:
Fido2
: User action is signed by a user's signing device usingWebAuthn
.Key
: User action is signed by a user's, or token's, private key.PasswordProtectedKey
: User action is signed by a user's, or token's, private key. The encrypted version of the private key is stored by Dfns and returns during the signing flow for the user to decrypt it.
The number of delegated wallets created and the wallet types are determined by the wallets
specifications. The end user is automatically assigned DfnsDefaultEndUserAccess
managed permission that grants the end user full access to the wallets.
Request headers required. See Request Headers for more information.
Temporary authentication token required. See Registration Headers for more information.
Required Permissions
Since this endpoint is not authenticated, the permissions apply to the application only.
Name | Conditions |
---|---|
| Always Required |
| Always Required |
| Always Required |
| Always Required |
Request body
|
| first factor credential that the end user is registering |
|
|
|
|
|
|
|
| delegated wallets that the end user should have |
Fido2 Credential
|
| will always be |
|
| |
|
| base64url encoded id of the credential |
|
| base64url encoded client data object. The underlying object is the clientData object returned by the user's WebAuthn client |
|
| base64url encoded attestation data object. The underlying object is the attestationData object returned by the user's WebAuthn client |
Key Credential
|
| will always be |
|
| |
|
| base64url encoded id of the credential |
|
| Client Data JSON object, stringified and base64url-encoded |
|
| base64url encoded Attestation Data JSON string object with the users signature and public key |
Password Protected Key Credential
|
| will always be |
|
| |
|
| base64url encoded id of the credential |
|
| Client Data JSON object, stringified and base64url-encoded |
|
| base64url encoded Attestation Data JSON string object with the user's signature and public key |
|
| Encrypted private key. The user should hold the secret to decrypting this value, and that secret should never be transmitted to Dfns |
Recovery Credential
|
| will always be |
|
| |
|
| base64url encoded id of the credential |
|
| Client Data JSON object, stringified and base64url-encoded |
|
| base64url encoded Attestation Data JSON string object with the user's signature and public key |
|
|
|
Wallets
|
| Network used for the wallet (See Supported Networks + Pseudo Network for possible values) |
|
| Optional name given to the wallet |
Example
Responses
See Common Errors for common errors.
See User Registration Errors for user registration specific errors.
Success - an object describing the end user and the delegated wallets
Last updated