Register StepCreate

POST

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

POST

/api/DigitalIdentity/Register/StepCreate

$ curl -X POST https://api.vlenseg.com/api/DigitalIdentity/Register/StepCreate \
>      -H "ApiKey: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Digital Identity - Registration_postDigitalIdentityRegisterStepCreate_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 }

Completes user registration and returns a user access token. For CDI onboarding, pass SkipEmail: true to skip the email OTP step after Register/StepVerifyCDI succeeds.

Authentication

ApiKeystring

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

Request

This endpoint expects an object.

geoLocationobjectOptional

imeistringOptional

passwordstringOptional

usernamestringOptional

Typically the user's phone number.

phoneNumberOtpRequestIdstringOptional

emailOtpRequestIdstringOptional

oAuthTokenVerificationRequestIdstringOptional

SkipEmailbooleanOptional

When true, skips email OTP verification. Required for CDI registration after Register/StepVerifyCDI succeeds.

Response

dataobject

error_codestring

error_messagestring