Register Validate Phone OTP

POST

https://api.vlenseg.com/api/DigitalIdentity/Register/StepVerifyPhone

POST

/api/DigitalIdentity/Register/StepVerifyPhone

$ curl -X POST https://api.vlenseg.com/api/DigitalIdentity/Register/StepVerifyPhone \
>      -H "ApiKey: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "phoneNumber": "{{di_userPhoneNumber}}",
>   "phoneNumberOtpRequestId": "{{reg_phoneNumberOtpRequestId}}",
>   "phoneNumberOtp": ""
> }'

200Digital Identity - Registration_postDigitalIdentityRegisterStepVerifyPhone_example

1 {
2   "data": {
3     "isEmailConfirmationRequired": "<boolean>",
4     "isEmailConfirmed": "<boolean>",
5     "isPhoneNumberConfirmationRequired": "<boolean>",
6     "isPhoneNumberConfirmed": "<boolean>",
7     "phoneNumberOtp": "<string>",
8     "phoneNumberOtpRequestId": "<uuid>",
9     "isDigitalIdentityVerified": "<boolean>",
10     "accessToken": "<string>",
11     "encryptedAccessToken": "<string>",
12     "expireInSeconds": "<integer>",
13     "userName": "<string>",
14     "userFullName": "<string>",
15     "user": {
16       "name": "<string>",
17       "surname": "<string>",
18       "fullName": "<string>",
19       "userName": "<string>",
20       "emailAddress": "<string>",
21       "phoneNumber": "<string>",
22       "idNumber": "<string>"
23     }
24   },
25   "error_code": "<integer>",
26   "error_message": "<string>"
27 }

Send or validate a phone OTP during registration. Set useCdi: true when sending the OTP for Consent-based Digital Identity (CDI) onboarding — the message informs the user they are consenting to link their network identity with your organization.

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

Request

This endpoint expects an object.

phoneNumberstringRequired

phoneNumberOtpRequestIdstringRequired

phoneNumberOtpstringRequired

useCdibooleanOptional

When true, sends a CDI onboarding OTP instead of a standard registration OTP.

Response

dataobject

error_codestring

error_messagestring