Skip to content

Validate Registration.

POST
/no_auth/login/validate_registration
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/no_auth/login/validate_registration \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com", "tenant_type": "UNKNOWN", "token": "example" }'

ValidateRegistration validates if the signup registration request is valid when a new customer attempts to signup.

Examples of this operation.

Media typeapplication/json
Request to validate registration

ValidateRegistrationRequest is the request body parameeters required to validate the registration.

object
email
email of the user

Email of the user requesting for Required: YES.

string format: email
<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/
tenant_type
string
default: UNKNOWN
Allowed values: UNKNOWN FREEMIUM ENTERPRISE
token
token of the user

Token of the user requesting for Required: YES.

string
<= 1024 characters

A successful response.

Media typeapplication/json
Response to validate registration

ValidateRegistrationResponse is the response that indicates if the registration is valid or not. For a brand new registration, the valid_registration is set to true that indicates that signup flow can flow through. In case of an existing user, the valid_registration is set to false.

object
err
string
default: EUNKNOWN
Allowed values: EUNKNOWN ETOKEN_OK ETOKEN_FAILED ETOKEN_NOTFOUND ETOKEN_USED ETOKEN_EXPIRED EUSER_OK EUSER_EXISTS EUSER_FAILED ECONTACT_VALIDATE_OK ECONTACT_EMPTY_COUNTRY ECONTACT_EMPTY_ZIP_CODE ECONTACT_UNKNOWN_COUNTRY ECONTACT_INVALID_ZIP EOK ENO_STATES ENO_CITIES
valid_registration
Valid registration

Valid registration flag indicates if the registration is valid.

boolean format: boolean
Example
{
"err": "EUNKNOWN"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example