Check Availability
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/profiles/availability \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"mobile_phone": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/profiles/availability"
payload = {
"email": "jsmith@example.com",
"mobile_phone": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jsmith@example.com', mobile_phone: '<string>'})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/availability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/profiles/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'jsmith@example.com',
'mobile_phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/profiles/availability"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"mobile_phone\": \"<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))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/profiles/availability")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"mobile_phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\",\n \"mobile_phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"available": true,
"profile": {
"id": "<string>"
}
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Profile
Check Availability
A POST to the /profiles/availability endpoint allows your application get the availability of an email or mobile
POST
/
v3
/
profiles
/
availability
Check Availability
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/profiles/availability \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"mobile_phone": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/profiles/availability"
payload = {
"email": "jsmith@example.com",
"mobile_phone": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jsmith@example.com', mobile_phone: '<string>'})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/availability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/profiles/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'jsmith@example.com',
'mobile_phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/profiles/availability"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"mobile_phone\": \"<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))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/profiles/availability")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"mobile_phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\",\n \"mobile_phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"available": true,
"profile": {
"id": "<string>"
}
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Check the availability of an Omneo profile by Email or Mobile
The /availability endpoint allows developers to check if an Omneo profile exists matching either anemail or mobile_phone
This endpoint can be used to check for a customers Omneo profile, as form validation, before creating a profile, or quickly get a customers id or full name, providing only an email or phone number.
| Attribute | Description |
|---|---|
available BOOLEAN | Will be returned true if a match has been found. and false if no match is found |
email STRING | A valid email to search for an Omneo profile |
mobile_phone STRING | A valid E.164 Mobile number to search for an Omneo Profile |
{
"data": {
"email": {
"available": false,
"profile": {
"id": "92bb9859-9d4f-465e-8905-13c6c02fb1c6",
"full_name": "John Smith"
}
},
"mobile_phone": {
"available": true,
"profile": null
}
}
}
⌘I