Start a verification of an identity by generating a code. This code can be sent to the User using the Verify Send API Verification Code API or using a mechanism outside of FusionAuth. The verification is completed by using the Verify Complete API with this code.

post/api/identity/verify/start

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/identity/verify/start
  • Auth: API key in header Authorization

Request body

applicationIdstring uuid
existingUserStrategy'mustExist' | 'mustNotExist'

Represent the various statesexpectations of a user in the context of starting verification

loginIdstring
loginIdTypestring
stateobject
verificationStrategy'ClickableLink' | 'FormField'

Response

Success

oneTimeCodestring
verificationIdstring

Changes

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