post https://{tenant}.getomneo.com/api/v3/profiles/availability
A POST
to the /profiles/availability
endpoint allows your application get the availability of an email or mobile
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.
Attribute | Description |
---|---|
availableBOOLEAN | Will be returned true if a match has been found.and false if no match is found |
emailSTRING | A valid email to search for an Omneo profile |
mobile_phoneSTRING | 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
}
}
}