Skip to main content
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>"
}
'
{
  "data": [
    {
      "available": true,
      "profile": {
        "id": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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 an email 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.
AttributeDescription
available BOOLEANWill be returned true if a match has been found. and false if no match is found
email STRINGA valid email to search for an Omneo profile
mobile_phone STRINGA 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
        }
    }
}

Body

application/json
​
email
string<email> | null
​
mobile_phone
string | null

Response

​
data
(object | null)[]
required