Skip to content
Authrim

Verify and link a DID registration proof.

POST
/api/auth/dids/register/verify
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/auth/dids/register/verify \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "challenge_id": "challenge_123", "proof": "eyJhbGciOiJFZERTQSJ9..." }'

Verifies the DID proof for a prior registration challenge and links the DID to the current authenticated session user, then publishes the lookup route DID login uses to find the account. Refused with 403 when the tenant has DID login off (authentication-methods.did.login_enabled, default false), and with 503 when that setting cannot be read, before the challenge is consumed. Answers 503 temporarily_unavailable when the lookup route could not be published; repeat the link (new challenge and proof) to complete it.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
challenge_id
required
string
proof
required
string
Example 
{
  "challenge_id": "challenge_123",
  "proof": "eyJhbGciOiJFZERTQSJ9..."
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
required
boolean
did
required
string
message
required
string
Example 
{
  "success": true,
  "did": "did:web:example.com",
  "message": "DID successfully linked to your account"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}