Verify
Trigger SMS Verification Code POST /verify/sms/send-code
Check SMS Verification Code POST /verify/sms/check-code
Get Verification GET /verify/{verificationId}
List Verifications GET /verify
Verify Phone Number POST /verify/number
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tostringRequired
serviceNamestringOptional
timeoutSecondsnumberOptional
codeLengthnumberOptional
realtimebooleanOptional
bypassbooleanOptional
externalIdstringOptional
longcodeIdnumberOptional
poolIdstringOptional
senderNamestringOptional
gatedbooleanOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
post
/verify/sms/send-codeAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tostringOptional
verificationIdstringOptional
codestringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
post
/verify/sms/check-codeAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verificationIdstringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
get
/verify/{verificationId}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
get
/verifyAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
numberstringRequired
bypassbooleanOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
post
/verify/numberLast updated
Was this helpful?