Vero OMS API

POST

https://api-gw.verolabs.co

api

authen

self-service

recovery

Send or verify a recovery code

curl --request POST \
  --url https://api-gw.verolabs.co/api/authen/self-service/recovery \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "code",
  "email": "jsmith@example.com"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({method: 'code', email: 'jsmith@example.com'})
};

fetch('https://api-gw.verolabs.co/api/authen/self-service/recovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-gw.verolabs.co/api/authen/self-service/recovery"

payload = {
    "method": "code",
    "email": "jsmith@example.com"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gw.verolabs.co/api/authen/self-service/recovery"

	payload := strings.NewReader("{\n  \"method\": \"code\",\n  \"email\": \"jsmith@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-gw.verolabs.co/api/authen/self-service/recovery");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"method\": \"code\",\n  \"email\": \"jsmith@example.com\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

false

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-gw.verolabs.co/api/authen/self-service/recovery");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"method\": \"code\",\n  \"email\": \"jsmith@example.com\"\n}");

CURLcode ret = curl_easy_perform(hnd);

{
  "id": "<string>",
  "type": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "ui": {},
  "state": "<string>",
  "request_url": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "refresh": true,
  "requested_aal": "<string>",
  "identity": "<unknown>",
  "session_token": "<string>",
  "continue_with": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

Query Parameters

flow

string

required

Flow identifier returned by the matching create-flow endpoint. Submit/update requests must use the same flow id.

Body

application/json

self-service flow update payload. Pass the flow id in the query string and include the fields required by the selected method.

Option 1
Option 2

Payload used to request a recovery code for the email address on an recovery flow.

method

enum<string>

required

Recovery method. Use code for email code recovery.

Available options:

code

string<email>

required

Email address that should receive the recovery code.

Response

Recovery flow updated. A passed challenge can return session_token directly or continue_with instructions that include set_session_token.

Updated recovery flow response. Successful verification can include session_token or continue_with instructions.

string

Flow id. Use this value as the flow query parameter when submitting or updating the flow.

type

string

Flow type returned by the system, for example browser or api.

expires_at

string<date-time>

Timestamp when the flow expires. Submit the flow before this time.

issued_at

string<date-time>

Timestamp when created the flow.

object

UI payload containing action URL, method, nodes, messages, and CSRF node when required.

state

string

Current flow state, such as choose_method, sent_email, passed_challenge, or success.

request_url

string

Original request URL used to create the flow.

organization_id

string | null

organization id for organization-scoped flows, when supplied.

created_at

string<date-time>

Flow creation timestamp.

updated_at

string<date-time>

Flow update timestamp.

refresh

boolean

Whether the flow is a refresh flow.

requested_aal

string

Requested authenticator assurance level for the flow.

identity

any

Identity attached to settings flows when the system includes it.

session_token

string

Session token returned after successful recovery verification, when issued directly.

continue_with

object[]

Follow-up actions returned by the system, such as set_session_token instructions.

Create a settings flow for password changeCreate a settings flow for password change

Send or verify a recovery code

curl --request POST \
  --url https://api-gw.verolabs.co/api/authen/self-service/recovery \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "code",
  "email": "jsmith@example.com"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({method: 'code', email: 'jsmith@example.com'})
};

fetch('https://api-gw.verolabs.co/api/authen/self-service/recovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-gw.verolabs.co/api/authen/self-service/recovery"

payload = {
    "method": "code",
    "email": "jsmith@example.com"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gw.verolabs.co/api/authen/self-service/recovery"

	payload := strings.NewReader("{\n  \"method\": \"code\",\n  \"email\": \"jsmith@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-gw.verolabs.co/api/authen/self-service/recovery");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"method\": \"code\",\n  \"email\": \"jsmith@example.com\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

false

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-gw.verolabs.co/api/authen/self-service/recovery");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"method\": \"code\",\n  \"email\": \"jsmith@example.com\"\n}");

CURLcode ret = curl_easy_perform(hnd);

{
  "id": "<string>",
  "type": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "ui": {},
  "state": "<string>",
  "request_url": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "refresh": true,
  "requested_aal": "<string>",
  "identity": "<unknown>",
  "session_token": "<string>",
  "continue_with": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

Overview

REST API

Streaming API

Integrations

Support

Send or verify a recovery code

Query Parameters

Body

Response