For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
HomeAPI Reference
HomeAPI Reference
  • Overview
    • API Overview
  • Vlens API
      • POSTCheck for duplicate accounts
      • POSTSend or validate phone OTP
      • POSTSend or validate email OTP
      • POSTComplete registration
      • POSTVerify OAuth token during registration
      • POSTVerify OAuth token (skip email at registration)
Dashboard
LogoLogo
Vlens APIRegistration

Complete registration

||View as Markdown|
POST
https://api.vlenseg.com/api/DigitalIdentity/Register
POST
/api/DigitalIdentity/Register
$curl -X POST https://api.vlenseg.com/api/DigitalIdentity/Register \
> -H "ApiKey: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "phoneNumber": "+201234567890",
> "email": "user@example.com",
> "password": "SecurePass123!",
> "phoneNumberOtp": "123456",
> "phoneNumberOtpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
>}'
200Registration_register_example
1{
2 "data": {
3 "isDigitalIdentityVerified": false,
4 "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
5 "expireInSeconds": 86400,
6 "user": {
7 "id": 42,
8 "emailAddress": "user@example.com",
9 "phoneNumber": "+201234567890"
10 }
11 },
12 "error_code": null
13}

Finalize user registration after phone (and optionally email) verification. On success, returns an access token for the new user. Use this token in Authorization: Bearer <token> for all subsequent user-scoped requests.

Was this page helpful?
Previous

Send or validate email OTP

Next

Verify OAuth token during registration

Built with

Authentication

ApiKeystring
Static API key issued to your tenant. Obtain from the Vlens dashboard.

Request

This endpoint expects an object.
phoneNumberstringRequired
emailstring or nullOptionalformat: "email"
passwordstring or nullOptionalformat: "password"
phoneNumberOtpstring or nullOptional
phoneNumberOtpRequestIdstring or nullOptionalformat: "uuid"
geoLocationstring or nullOptional
Device location string at registration time.
imeistring or nullOptional

Device identifier (optional).

oAuthTokenVerificationRequestIdstring or nullOptionalformat: "uuid"

OAuth verification request ID from StepVerifyOAuthToken or VerifyOAuthToken. Providing this skips the email verification step.

Response

User registered successfully. Store the returned accessToken.

dataobject
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null