Authentication

Start authenticator enrollment

Changed on

Creates an unconfirmed authenticator method and returns the shared secret. The secret is returned only by this call and cannot be retrieved again. Two-factor authentication is not active until the enrollment is confirmed.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/users/self/mfa/totp

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/users/self/mfa/totp
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Request body

labelstring

Example request

{
  "label": "My phone"
}

Response

Enrollment started

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "id": "a1b2c3d4e5f60718293a4b5c6d7e8f90",
    "secret": "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ",
    "provisioning_uri": "otpauth://totp/user%40example.com?issuer=Assinafy&secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ"
  }
}

Changes