Verify a door code

Verify and consume a six-digit door code. A code works once. Returns 409 used if its proof has already been spent.

post/v1/otp/verify

Request

  • Base URL: https://api.affix-io.com
  • URL: https://api.affix-io.com/v1/otp/verify
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

otpstring
proof_digeststring

Optional. When given, the code must belong to this proof.

Response

Valid. allow is true.

allowboolean
reason_codestring

VALID when allowed. Otherwise e.g. used, expired, not_found.

spentboolean

True once the bound proof has been consumed at a gate or the carrier was consumed.

carrierobject
policy_versionstring

Changes

No recorded changes to this operation across all 1 revision of this API.