SG Developers Check email address for existence
Check email adress for existence
The /checkMailForExistence endpoint checks if an applicant with the given email address already exists in the database. The email is not validated before lookup, the API endpoint would also look up for strings like ‘abc123’ or ‘foo@bar’.
Request with tokens
By sending the following GET-request, check an email adress:
|
1 2 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/checkMailForExistence?email={email}" |
with TOKEN either being a client access token or a user access token. It is used to determine the validity of this request. The query parameter {email} is the address that will be checked for existence.
Request with basic authorization
As an alternative, you can use here the basic authorization method. Just write
|
1 2 |
curl -i -u "{clientId}:" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/checkMailForExistence?email={email}" |
{clientId} is the ID for your application to develop given to you by softgarden. The colon seen in the example is obligatory.
Path parameters
– none –
Query parameters
| Name | Description | Data Type |
|---|---|---|
| The email address to be checked. | String |
Response values
| Upon | Returned value | Description |
|---|---|---|
| success | true | If there is a user with that email address in the database. |
| failure | false | If there is no user with that email address in the database. |
| failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
| authorization error | 401 / 403 | See here for details. |