Examples in

Verificación telefónica

Un número de teléfono verificado puede servir como segundo factor de respaldo y como canal de recuperación para el caso poco habitual en el que un usuario ha perdido tanto su contraseña como su dispositivo TOTP/WebAuthn. La verificación es el flujo estándar de "te enviamos un código por SMS y lo introduces".

El SMS como factor principal de 2FA es más débil que TOTP o WebAuthn (ataques de SIM swapping, problemas de SS7). NimbusNexus admite la 2FA por SMS, pero usa TOTP por defecto en las altas nuevas; el SMS se ofrece solo como vía de recuperación en las cuentas del plan Production. Las cuentas Enterprise pueden desactivar el SMS por completo si su modelo de amenazas lo excluye.

Próximos pasos

Autenticación de dos factores — la configuración principal de la 2FA.
Usuarios — el recurso al que se asocian los números de teléfono.

Reference

GET/api/v1/phone/

Retrieve Phone

Return the verified phone number on file for the current user, if any.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/phone/" \
  -H "Authorization: Bearer $NIMBUS_KEY"

POST/api/v1/phone/

Add Phone

Stage a phone number for the current user and send a one-time SMS verification code to it.

Request body

Field	Type	Description
phone_code*	string	—
phone_number*	string	—

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/phone/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_code": "example",
    "phone_number": "example"
  }'

DELETE/api/v1/phone/

Delete Phone

Remove the current user's verified phone number and disable two-factor authentication.

Responses

204Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/phone/" \
  -H "Authorization: Bearer $NIMBUS_KEY"

POST/api/v1/phone/phone_passcode_validation

Phone Passcode Validation

Validate the SMS passcode and promote the staged phone number to verified.

Request body

Field	Type	Description
passcode*	string	—

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/phone/phone_passcode_validation" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "passcode": "example"
  }'

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub