Vero OMS API

POST

https://api-gw.verolabs.co

api

authen

self-service

registration

Submit registration data to a registration flow

curl --request POST \
  --url https://api-gw.verolabs.co/api/authen/self-service/registration \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "password",
  "traits": {
    "email": "jsmith@example.com",
    "name": {
      "first": "<string>",
      "last": "<string>"
    },
    "documentNumber": "<string>",
    "phone": "<string>",
    "refer_code": "<string>",
    "address": "<string>"
  },
  "password": "<string>",
  "csrf_token": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'password',
    traits: {
      email: 'jsmith@example.com',
      name: {first: '<string>', last: '<string>'},
      documentNumber: '<string>',
      phone: '<string>',
      refer_code: '<string>',
      address: '<string>'
    },
    password: '<string>',
    csrf_token: '<string>'
  })
};

fetch('https://api-gw.verolabs.co/api/authen/self-service/registration', 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/registration"

payload = {
    "method": "password",
    "traits": {
        "email": "jsmith@example.com",
        "name": {
            "first": "<string>",
            "last": "<string>"
        },
        "documentNumber": "<string>",
        "phone": "<string>",
        "refer_code": "<string>",
        "address": "<string>"
    },
    "password": "<string>",
    "csrf_token": "<string>"
}
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/registration"

	payload := strings.NewReader("{\n  \"method\": \"password\",\n  \"traits\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": {\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    },\n    \"documentNumber\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"refer_code\": \"<string>\",\n    \"address\": \"<string>\"\n  },\n  \"password\": \"<string>\",\n  \"csrf_token\": \"<string>\"\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/registration");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"method\": \"password\",\n  \"traits\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": {\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    },\n    \"documentNumber\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"refer_code\": \"<string>\",\n    \"address\": \"<string>\"\n  },\n  \"password\": \"<string>\",\n  \"csrf_token\": \"<string>\"\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/registration");

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\": \"password\",\n  \"traits\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": {\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    },\n    \"documentNumber\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"refer_code\": \"<string>\",\n    \"address\": \"<string>\"\n  },\n  \"password\": \"<string>\",\n  \"csrf_token\": \"<string>\"\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>"
}

{
  "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.

JSON payload used to submit a new user registration to an registration flow.

method

enum<string>

required

Registration method. The client submits password for password-based registration.

Available options:

password

traits

object

required

User identity traits to create on the identity.

Hide child attributes

traits.email

string<email>

required

Customer email address. Must be unique for the identity.

traits.name

object

required

Customer legal name split into first and last names.

Hide child attributes

traits.name.first

string

required

Given name or first part of the customer name.

traits.name.last

string

required

Family name or last part of the customer name.

traits.documentNumber

string

required

Government identity document number collected during onboarding.

traits.phone

string

Customer phone number in the format collected by the app.

traits.refer_code

string

Optional referral code entered during registration.

traits.address

string

Customer residential/contact address.

password

string<password>

required

Password to attach to the new identity. The mobile app can generate a secure random password for OTP-based onboarding.

csrf_token

string

CSRF token copied from the registration flow UI node when required.

Response

Registration flow accepted. The response is the updated registration flow and may include additional session fields when immediate session creation is enabled.

self-service flow object returned by login, registration, recovery, and settings create/update endpoints.

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.

Parse ID card images during signupParse ID card images during signup

Submit registration data to a registration flow

curl --request POST \
  --url https://api-gw.verolabs.co/api/authen/self-service/registration \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "password",
  "traits": {
    "email": "jsmith@example.com",
    "name": {
      "first": "<string>",
      "last": "<string>"
    },
    "documentNumber": "<string>",
    "phone": "<string>",
    "refer_code": "<string>",
    "address": "<string>"
  },
  "password": "<string>",
  "csrf_token": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'password',
    traits: {
      email: 'jsmith@example.com',
      name: {first: '<string>', last: '<string>'},
      documentNumber: '<string>',
      phone: '<string>',
      refer_code: '<string>',
      address: '<string>'
    },
    password: '<string>',
    csrf_token: '<string>'
  })
};

fetch('https://api-gw.verolabs.co/api/authen/self-service/registration', 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/registration"

payload = {
    "method": "password",
    "traits": {
        "email": "jsmith@example.com",
        "name": {
            "first": "<string>",
            "last": "<string>"
        },
        "documentNumber": "<string>",
        "phone": "<string>",
        "refer_code": "<string>",
        "address": "<string>"
    },
    "password": "<string>",
    "csrf_token": "<string>"
}
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/registration"

	payload := strings.NewReader("{\n  \"method\": \"password\",\n  \"traits\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": {\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    },\n    \"documentNumber\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"refer_code\": \"<string>\",\n    \"address\": \"<string>\"\n  },\n  \"password\": \"<string>\",\n  \"csrf_token\": \"<string>\"\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/registration");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"method\": \"password\",\n  \"traits\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": {\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    },\n    \"documentNumber\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"refer_code\": \"<string>\",\n    \"address\": \"<string>\"\n  },\n  \"password\": \"<string>\",\n  \"csrf_token\": \"<string>\"\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/registration");

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\": \"password\",\n  \"traits\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": {\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    },\n    \"documentNumber\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"refer_code\": \"<string>\",\n    \"address\": \"<string>\"\n  },\n  \"password\": \"<string>\",\n  \"csrf_token\": \"<string>\"\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>"
}

{
  "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

Submit registration data to a registration flow

Query Parameters

Body

Response