Sign in
auth v2

Verify phone OTP.

Changed on

Use this endpoint to verify phone number

post/phone-number/verify

Request

  • Base URL: https://api.openfort.io/iam/v2/auth
  • URL: https://api.openfort.io/iam/v2/auth/phone-number/verify
  • Auth: HTTP bearer and API key in header x-project-key

Request body

phoneNumberstring required

Phone number to verify. Eg: "+1234567890"

codestring required

OTP code. Eg: "123456"

disableSessionboolean nullable

Disable session creation after verification. Eg: false

updatePhoneNumberboolean nullable

Check if there is a session and update the phone number. Eg: true

Response

Phone number verified successfully

statustrue required

Indicates if the verification was successful

tokenstring nullable

Session token if session is created, null if disableSession is true or no session is created

Changes

  • 1798dba338e5Revision changes
    • info

      the endpoint scheme security auth_token AND projectKey was added to the API

    • info

      the endpoint scheme security bearerAuth was removed from the API

  • 7b002ab01aceRevision changes
    • info

      api tag auth v2 added

    • info

      api tag Phone-number removed